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-02-13 00:19:57

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": "74f03a71-1375-4248-8c67-2123912b859f",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "4ba1e6f6-9704-4c04-89a1-01a0edf4ea61",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "cc5189b9-7cc3-43eb-b09d-6f4a6cd8a990",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "f2558458-42c3-4c4c-aa9b-ad4662f0f22e",
                "createdAtUtc": "2026-02-13T00:19:56.0080467Z",
                "createdById": "ac65fa1b-ed90-4204-aff4-0424a373035e",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-02-13T00:19:56.0080475Z",
                "lastUpdateById": "e0559975-44a0-4ea0-ac02-82e6bc2c4da6",
                "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": "fc5ab61b-7116-4f8b-87a8-22fc3d9e8fcb",
                "createdAtUtc": "2026-02-13T00:19:56.0080493Z",
                "createdById": "6584e196-21b6-401d-a408-03e3fae04808",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-02-13T00:19:56.00805Z",
                "lastUpdateById": "5ab61292-4eff-46a7-bb8a-8efc4a8761d2",
                "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-02-13 00:19:57

List user vaults

Favorite vault