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:2025-09-17 00:11:52

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?PageSize&PageNumber&OrderByDirection' \
--header 'x-api-token: <api-key>'

Responses

🟢200OK

application/json

Vault listed successfully

Body

Example

{
    "vault": {
        "id": "a470b9f1-5c30-454f-8387-4c9fed66ce3c",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "7d2ddd82-9519-4cfb-9230-58a8b61e5a94",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "e2970438-3aff-4f1a-9890-a65568e8aef9",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "ddf5a087-a509-413e-bc98-7328312668b1",
                "createdAtUtc": "2025-09-17T00:11:51.2109394Z",
                "createdById": "7151b1ab-192c-4dc1-84bc-b62caddba822",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2025-09-17T00:11:51.2109413Z",
                "lastUpdateById": "b80a7a3d-0b93-44a7-a0f7-c51242b2c732",
                "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": "be3933b0-c7fe-4d17-9a66-df58b85049f2",
                "createdAtUtc": "2025-09-17T00:11:51.2109493Z",
                "createdById": "4e93c1c2-45ba-4773-a939-6142a0211192",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2025-09-17T00:11:51.2109511Z",
                "lastUpdateById": "31fb4936-fff5-40b1-804a-53eda40fb96e",
                "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 2025-09-17 00:11:52

List user vaults

Favorite vault