List vaults

List vaults, with optional filtering by status, name, signer, and owner. signerId can be any signer in your organisation, not only your own. An unknown signer, or a signer in another organisation, matches nothing and returns an empty list. When access control is enforced, another user's signer needs the signer device manage permission, and otherwise matches nothing.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
1 to 100

Maximum number of items to return. Defaults to 10.

length between 1 and 500

The nextCursor value from the previous page.

enum

Sort direction. Defaults to desc.

null
Defaults to pending,active

Filter by vault status. Defaults to pending and active. Repeat the parameter to match several statuses, for example ?status=active&status=archived.

string
length between 1 and 64

Filter by vault name, case-insensitive partial match. For example, ?name=bit matches "Bitcoin Vault".

string | array

Filter by signer ID or external ID. Any signer in your organisation is accepted. Returns vaults where any of the given signers is active. Repeat the parameter for up to 10 signers, for example ?signerId=id1&signerId=id2. An unknown signer matches no vaults.

null

Filter by the product that owns the vault: io-sign or io-vault. Can be provided multiple times (e.g., ?owner=io-sign&owner=io-vault). A vault with no recorded owner matches neither value. Without this filter, vaults are listed whatever their owner. Owners are set by the access:vault-owner operator command. The filter narrows the vaults the caller may read; it never widens them.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json