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-09-25 02:56:36

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": "0f793383-184c-4fa9-87f1-9b75dd98cae3",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "6801f579-7836-4bfc-adf5-d01aa0b33e8a",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "df273d05-bd68-421c-9f1f-54fd36bfa6a8",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "70213ecc-34d4-4e6b-8770-0d54e759893f",
                "createdAtUtc": "2026-09-25T02:56:33.9675478Z",
                "createdById": "89478272-ebbe-404d-9b98-c49889dca289",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-09-25T02:56:33.9675494Z",
                "lastUpdateById": "4d936484-a0a2-4b90-85bb-cea1dc621edb",
                "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": "417237ee-cee1-45a4-a0b0-562ec19eb5de",
                "createdAtUtc": "2026-09-25T02:56:33.9675526Z",
                "createdById": "9be822c5-49a9-45ae-90b2-f06e40bb14f5",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-09-25T02:56:33.9675542Z",
                "lastUpdateById": "9d6c077e-fc89-41c2-856e-13d3207a81e0",
                "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-09-25 02:56:36

List user vaults

Favorite vault