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-22 02:01:24

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": "d9f3420c-b62c-4988-86fa-7557daf7d10b",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "cc4ef450-7415-4314-9d2c-5543b3c0b7ea",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "58d7dea3-492c-4dab-8251-4515d1b4b5d7",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "f01766c0-dde5-4732-b345-29f36d929452",
                "createdAtUtc": "2026-07-22T02:01:20.7694079Z",
                "createdById": "08db187e-672d-4ece-aa1d-e1ee878d7c0e",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-07-22T02:01:20.769409Z",
                "lastUpdateById": "14dbef97-d493-4b77-8e61-d60ceca88cbc",
                "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": "71e83dd9-8473-4b90-9db0-fac6750265ae",
                "createdAtUtc": "2026-07-22T02:01:20.7694116Z",
                "createdById": "0242597a-6447-4e2d-bf74-bb053dc33cf5",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2026-07-22T02:01:20.7694127Z",
                "lastUpdateById": "9b906146-6888-4f7a-be78-8f33c7d00b0a",
                "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-22 02:01:24

List user vaults

Favorite vault