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-07-01 02:51:06

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": "4cd8fc26-b3b6-41a0-ab88-f7f581f6507f",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "dd51fac7-4fa4-4349-80cd-8aa2f19a950f",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "dc772a83-dd6f-4b6c-ac30-60d701d74168",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "fcd3a0db-5f37-4cf7-9f3a-8851ed82732d",
                "createdAtUtc": "2026-07-01T02:51:04.2723415Z",
                "createdById": "0e7a4993-1b87-472d-a64b-0571fa9d1f89",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-07-01T02:51:04.2723422Z",
                "lastUpdateById": "fc1a53ae-1c86-4af9-95d4-9b8044d1cda6",
                "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": "e0a63c34-9870-4ffe-8c3f-b360d5ab13cd",
                "createdAtUtc": "2026-07-01T02:51:04.2723441Z",
                "createdById": "11778c2f-5666-4c02-90da-6a5508cf28c5",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-07-01T02:51:04.2723449Z",
                "lastUpdateById": "0ad807e5-c0d1-40d2-93e3-2d3f7a1eaa0d",
                "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-07-01 02:51:06

List user vaults

Favorite vault