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-10-29 00:13:13

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": "43757eb8-519b-49a6-9ce6-06628cee0999",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "58e5f9a6-79b8-4a22-a689-c8d090efe5c0",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "01f80ceb-5fdc-4ca0-a7f4-2c274f99251b",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "82018c23-7510-4477-a2ee-a4c02bfed1f8",
                "createdAtUtc": "2025-10-29T00:13:12.2854067Z",
                "createdById": "9dfe8586-9e4c-4f37-bfb9-f0064693b2bf",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2025-10-29T00:13:12.2854075Z",
                "lastUpdateById": "119c72f7-7e13-45ed-9c70-60f9675e1272",
                "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": "af8d5588-0ef5-4d7e-985d-32441072da4e",
                "createdAtUtc": "2025-10-29T00:13:12.2854094Z",
                "createdById": "e5da082c-9fae-47a5-a990-bdf218c252d8",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2025-10-29T00:13:12.2854101Z",
                "lastUpdateById": "362ce59c-eb26-430e-af34-a5a698dd2da9",
                "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-10-29 00:13:13

List user vaults

Favorite vault