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-08-15 00:51:47

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": "d0231569-4032-4e69-a605-a4eb5126cda0",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "9fe1cce9-ab91-4a98-8930-b26436c9ce53",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "e4f69a7b-b274-41d3-8370-93becd912297",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "2b479bad-4b9f-4a66-a972-8d98e97cfd01",
                "createdAtUtc": "2026-08-15T00:51:45.6757075Z",
                "createdById": "ea53981c-3119-4dad-82e0-828445a234ab",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-08-15T00:51:45.6757083Z",
                "lastUpdateById": "f090f90f-6b83-4111-bed6-59218f99be18",
                "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": "c6c68d9a-46c8-417d-840a-69fbcbc9951e",
                "createdAtUtc": "2026-08-15T00:51:45.6757102Z",
                "createdById": "aea2ede8-a45b-419b-9d31-ef79c687c656",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-08-15T00:51:45.675711Z",
                "lastUpdateById": "3ad83f47-8076-4ceb-892a-3aaa8d5bc135",
                "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-08-15 00:51:47

List user vaults

Favorite vault