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-10-17 02:32:18

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": "0e35eb16-b943-448a-ab47-64db87f5069c",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "77747d0e-904c-49ca-988f-7f3bd437e06a",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "b9007b71-e010-45a4-8413-cf50bacea4be",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "b18442b2-955d-45ef-8e64-895788e77632",
                "createdAtUtc": "2026-10-17T02:32:16.9507305Z",
                "createdById": "255dd04c-633c-4b2f-97df-715428293fec",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-10-17T02:32:16.9507314Z",
                "lastUpdateById": "b36ebd9b-5ee9-4b20-9e6b-eab80c382292",
                "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": "08020938-be38-437a-a951-f9c439e2975f",
                "createdAtUtc": "2026-10-17T02:32:16.9507332Z",
                "createdById": "e5c44eca-832f-4edf-86c3-5f445cd182b5",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-10-17T02:32:16.9507342Z",
                "lastUpdateById": "6731f571-7eb4-4b62-b53b-2e8ae94086ff",
                "updatedByName": "John Doe",
                "updatedByAvatar": null,
                "name": "Example Template"
            }
        }
    ],
    "pagination": {
        "totalItems": 2,
        "pageSize": 10,
        "pageNumber": 1,
        "pageItems": 2
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429

Modified at 2026-10-17 02:32:18

List user vaults

Favorite vault