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-03-29 12:47:42

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

vaultId

string <uuid>

required

Vault ID

Query Params

ExcludeEnvelopes

boolean

optional

If true, excludes envelopes from the response

ExcludeTemplates

boolean

optional

If true, excludes templates from the response

string | null

optional

Search vaults by id or name

<= 200 characters

PageSize

integer <int32>

required

Number of items per page

>= 1<= 100

Default:

PageNumber

integer <int32>

required

Current page number

>= 1<= 4294967295

Default:

OrderByDirection

enum<string>

required

Order by direction

Allowed values:

ASCDESC

Default:

DESC

Request 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;'

Responses

🟢200OK

application/json

Vault listed successfully

Body

vault

null | allOf {1}

optional

Vault object

object (ListVaultVaultApiResponse)

optional

items

array[object (ListVaultApiResponseItem) {3}] | null

optional

Items of the vault

type

enum<string>

optional

Type of the item

Allowed values:

EnvelopeTemplate

envelope

null | allOf {1}

optional

Envelope object

template

null | allOf {1}

optional

Template object

pagination

null | allOf {1}

optional

Pagination metadata

object (Pagination)

optional

Pagination metadata

Example

{
    "vault": {
        "id": "c0733416-cdb5-4414-9739-05dd1e214e0e",
        "isSandbox": false,
        "name": "Example Vault",
        "type": "UserAccount",
        "canBeRemoved": true,
        "userAccountMembers": [
            {
                "id": "0828699e-0053-433c-9212-86bdd253e27c",
                "name": "John Doe",
                "avatar": null
            },
            {
                "id": "64e27a9c-ea2d-454f-b2f1-b07299e96411",
                "name": "Jane Smith",
                "avatar": "https://example.com/avatars/janesmith.png"
            }
        ]
    },
    "items": [
        {
            "type": "Envelope",
            "envelope": {
                "id": "a7d335c0-7ac1-4f41-95fc-c035667697ea",
                "createdAtUtc": "2025-03-29T12:47:40.318467Z",
                "createdById": "a641f2f9-fa99-4d8b-bf27-7503700f4e6c",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2025-03-29T12:47:40.3184678Z",
                "lastUpdateById": "baa603ac-ff78-43d4-b5e0-4c89ea2c3453",
                "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": "255c48a2-ef37-447f-97ff-7f13483a77ee",
                "createdAtUtc": "2025-03-29T12:47:40.3184695Z",
                "createdById": "c4e29b83-9ad7-4239-ae68-6e36cbc8e053",
                "createdByName": "John Doe",
                "createdByAvatar": null,
                "updatedAtUtc": "2025-03-29T12:47:40.3184703Z",
                "lastUpdateById": "d85298eb-d6c8-4ffe-9262-af6f449f2c73",
                "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-03-29 12:47:42

List user vaults

Favorite vault