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-03-29 00:21:46

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 --request GET 'https://api.signater.com/v1/ecm/vaults//list?ExcludeEnvelopes&ExcludeTemplates&Search&PageSize&PageNumber&OrderByDirection' \
--header 'x-api-token: <api-key>'

Responses

🟢200OK

application/json

Vault listed successfully

Body

Example

{
    "vault": {
        "id": "fdcee38d-f4f4-4502-bd6e-36c1c6c7285d",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "60423684-0f8e-4aab-a6fb-dd4808e7c88c",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "ee8eea5f-37aa-4a8f-b9fb-a34b0c39ea45",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "2346fe98-aadf-4729-8baf-9b3dfa9dab25",
                "createdAtUtc": "2026-03-29T00:21:44.8301575Z",
                "createdById": "8a68b3d5-2044-4268-995f-a43c748138d1",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-03-29T00:21:44.8301586Z",
                "lastUpdateById": "cdbc5b26-c086-4f7b-824f-f32866dd27af",
                "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": "9d6692c9-2ef3-4c56-ae53-06bc343fc578",
                "createdAtUtc": "2026-03-29T00:21:44.8301611Z",
                "createdById": "c546015e-33fe-445e-845d-de6b0a31546a",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-03-29T00:21:44.8301622Z",
                "lastUpdateById": "b0341af5-2287-4232-89d3-feb20623db4b",
                "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-03-29 00:21:46

List user vaults

Favorite vault