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-12-28 00:15:29

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": "028f807f-b86c-4492-952e-85e60d5559e9",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "b2d2b251-f03d-4543-8602-2da8d90bd649",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "1e64dae2-b96b-4d31-8d55-0fa7533f786c",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "db12ed2b-e142-406b-ac96-2da6f116cb84",
                "createdAtUtc": "2025-12-28T00:15:27.1876612Z",
                "createdById": "53626afd-7a40-4d88-adb0-5be94aa1f6ce",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2025-12-28T00:15:27.187662Z",
                "lastUpdateById": "a964d39c-9090-4298-b3ef-4ab36237cac3",
                "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": "c072f1f0-67d9-4fe4-a231-42884d0bffc5",
                "createdAtUtc": "2025-12-28T00:15:27.187664Z",
                "createdById": "d4880d87-054f-4f20-bcfc-62989c0edafe",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2025-12-28T00:15:27.1876648Z",
                "lastUpdateById": "3e3f922d-f052-495d-a4b3-40c534fb983d",
                "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-12-28 00:15:29

List user vaults

Favorite vault