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-04-17 00:26:04

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": "15d2e6f3-6080-422e-a396-a1176e127597",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "09125b48-9c6b-4eea-a422-12f066e788f4",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "6dda69a5-5cb9-4399-97a9-fc4df05306b6",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "d1f89316-bfa4-4510-80c4-b24dec5751f6",
                "createdAtUtc": "2026-04-17T00:26:02.9157134Z",
                "createdById": "b520dd67-0d70-4a25-86e4-f60e5e0b2fc6",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-04-17T00:26:02.9157142Z",
                "lastUpdateById": "1452f00c-8ca2-40c4-902e-8bfaf7e8f40f",
                "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": "7a02aded-2385-4d49-877c-117b6cf83951",
                "createdAtUtc": "2026-04-17T00:26:02.9157159Z",
                "createdById": "394aa4e9-4c67-431c-812f-6de94399570f",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-04-17T00:26:02.9157167Z",
                "lastUpdateById": "dc876a99-dcba-4e62-9e1c-8a15f0a53fd1",
                "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-04-17 00:26:04

List user vaults

Favorite vault