This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

List vault

GET

https://api.signater.com/v1/ecm/vaults/{vaultId}/list

Last modified:2026-05-13 00:34:43

Retrieves the contents of a specific vault, identified by its unique ID. This includes a list of envelopes and templates stored within the vault, allowing for easy management and access to the resources.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.signater.com/v1/ecm/vaults//list?ExcludeEnvelopes=undefined&ExcludeTemplates=undefined&Search=undefined&PageSize=undefined&PageNumber=undefined&OrderByDirection=undefined' \
--header 'x-api-token: <api-key>'

Responses

🟢200OK

application/json

Vault listed successfully

Bodyapplication/json

Example

{
    "vault": {
        "id": "cf0ad1d0-0f5c-4175-9c44-e6c91f8a7117",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "4436a6d9-5480-44e5-9dc2-c20f063080b0",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "cc94fe8c-4dea-42c8-8e7a-bcc7ed10a769",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "775581f9-03d6-4d3f-ad76-43c3ff948c8a",
                "createdAtUtc": "2026-05-13T00:34:41.8412067Z",
                "createdById": "b1412338-122b-4bdb-9c9a-696830411770",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-05-13T00:34:41.8412076Z",
                "lastUpdateById": "8cf4d98c-3f65-47eb-ad5c-6ff18616e1a3",
                "updatedByName": "John Doe",
                "updatedByAvatar": null,
                "status": "Draft",
                "name": "Example Envelope",
                "privateDescription": "This is an example of an envelope used for demonstration purposes.",
                "canBeRemoved": true,
                "signers": [
                    {
                        "name": "Jane Smith",
                        "email": "jane.smith@example.com"
                    }
                ]
            },
            "template": null
        },
        {
            "type": "Template",
            "envelope": null,
            "template": {
                "id": "56d8586f-28b2-4645-a6a8-94b43fe492b9",
                "createdAtUtc": "2026-05-13T00:34:41.8412094Z",
                "createdById": "93684801-15fa-40a2-890b-3af1464e09f8",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-05-13T00:34:41.8412102Z",
                "lastUpdateById": "8d2f2c1a-a224-4fd3-a695-97b8df04cb2b",
                "updatedByName": "John Doe",
                "updatedByAvatar": null,
                "name": "Example Template"
            }
        }
    ],
    "pagination": {
        "totalItems": 2,
        "pageSize": 10,
        "pageNumber": 1,
        "pageItems": 2
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2026-05-13 00:34:43

List user vaults

Favorite vault