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-11-09 04:03:01

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&orderByColumn=undefined&status=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": "abdf8d35-2bbd-4669-b184-f3800b6ae49d",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "ef3f62ae-a936-42c4-b1ad-380a3f2f5b3e",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "95da528c-335f-49ba-8ece-803a1f006ae3",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "3932fdd6-597c-43e1-a5cd-04b9eb87a8fc",
                "createdAtUtc": "2026-11-09T04:02:58.0304898Z",
                "createdById": "eef38441-0339-46d0-a9df-35c530a099b6",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-11-09T04:02:58.0304905Z",
                "lastUpdateById": "6b09452e-9917-4e34-a3ca-e9120d828385",
                "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": "9331de38-d67f-44a5-bc39-5927f94ee842",
                "createdAtUtc": "2026-11-09T04:02:58.0304919Z",
                "createdById": "3b87f263-56e6-4202-b444-f08263a96920",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-11-09T04:02:58.0304926Z",
                "lastUpdateById": "cb9a0469-21a9-4fd0-87aa-58e18fb2e18f",
                "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-11-09 04:03:01

List user vaults

Favorite vault