This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

List current user vaults

GET

https://api.signater.com/v1/ecm/vaults/user-accounts

Vault

Last modified:2025-03-29 12:47:42

Retrieves a list of vaults that are accessible to the currently authenticated user. This includes personal vaults, as well as shared or restricted vaults the user has access to, depending on their permissions.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Query Params

IsFavorite

boolean | null

optional

Filter vaults by favorite status

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/user-accounts?PageSize&PageNumber&OrderByDirection' \
--header 'x-api-token;'

Responses

🟢200OK

application/json

User account vaults listed successfully

Body

items

array[object (ListUserAccountVaultsApiResponseItem) {12}] | null

optional

List of vaults

string <uuid>

optional

Id of the vault

createdAtUtc

string <date-time>

optional

Date and time when the vault was created in UTC

createdByName

string | null

optional

Name of the user who created the vault

createdByAvatar

string | null

optional

Url of the avatar of the user who created the vault

updatedAtUtc

string <date-time>

optional

Date and time when the vault was last updated in UTC

updatedByName

string | null

optional

Name of the user who last updated the vault

updatedByAvatar

string | null

optional

Url of the avatar of the user who last updated the vault

name

string | null

optional

Name of the vault

type

enum<string>

optional

Type of the vault

Allowed values:

AccountUserAccountUserAccountGroup

isFavorite

boolean

optional

Indicates if the vault is marked as favorite

canBeRemoved

boolean

optional

Indicates if the vault can be removed, only vaults with no items (envelopes and templates) can be removed

userAccountMembers

array[object (ListUserAccountVaultsApiResponseItemUserAccountMember) {5}] | null

optional

Members of the vault

pagination

null | allOf {1}

optional

Pagination metadata

object (Pagination)

optional

Pagination metadata

Example

{
    "items": [
        {
            "id": "a2065e05-a46c-4381-891a-3433901e12a2",
            "createdAtUtc": "2025-03-29T12:47:40.3145389Z",
            "createdByName": "John Doe",
            "createdByAvatar": null,
            "updatedAtUtc": "2025-03-29T12:47:40.314539Z",
            "updatedByName": "John Doe",
            "updatedByAvatar": null,
            "name": "Example Vault",
            "type": "UserAccount",
            "isFavorite": false,
            "canBeRemoved": true,
            "userAccountMembers": [
                {
                    "id": "a66c4249-e599-4e62-abae-ad6ef544b1d3",
                    "name": "John Doe",
                    "email": "john.doe@example.com",
                    "avatar": null,
                    "isActive": true
                }
            ]
        }
    ],
    "pagination": {
        "totalItems": 1,
        "pageSize": 10,
        "pageNumber": 1,
        "pageItems": 1
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-03-29 12:47:42

List account vaults

List user vaults