Skip to main content
GET
List vaults

Authorizations

api-key
string
header
required
api-sign
string
header
required
api-nonce
string
header
required

Query Parameters

org_iiban
string

Restrict the result set to vaults owned by the specified organization, identified by its 16-char IIBAN. Defaults to the caller's organization when omitted.

quote_asset
string

Asset code used to value each vault's fiat balance (e.g. USD, EUR). Defaults to USD when omitted.

limit
integer<int32>

Maximum number of vaults to return in the page. Defaults to 100 when omitted.

offset
integer<int32>

Number of vaults to skip before the page begins, used together with limit for offset-based pagination. Defaults to 0 when omitted.

id
string[]

Restrict the result set to the supplied vault IDs. Each value is a V-prefixed 14-char base32 identifier with a final check character.

iiban
string[]

Restrict the result set to vaults whose IIBAN matches one of the supplied values. Each value is a 16-char alphanumeric IIBAN in 4x4 groups.

member
string[]

Restrict the result set to vaults that include the supplied member(s), each identified by their 16-char user IIBAN.

name
string

Filter vaults by name. Combined with name_match and name_case to control how the term is matched.

name_match
string

How the name term is matched against vault names. One of equals, starts_with, contains.

name_case
string

Case sensitivity of the name match. One of sensitive, insensitive.

default_approvals_left
integer<int32>

Lower bound (inclusive) for the vault's default required-approvals count.

default_approvals_right
integer<int32>

Upper bound (inclusive) for the vault's default required-approvals count.

created_at_from
string<date-time>

Include only vaults created at or after this RFC 3339 UTC timestamp (inclusive), e.g. 2026-01-15T12:34:56Z; the Z (UTC) offset is required.

created_at_to
string<date-time>

Include only vaults created at or before this RFC 3339 UTC timestamp (inclusive), e.g. 2026-01-15T12:34:56Z; the Z (UTC) offset is required.

updated_at_from
string<date-time>

Include only vaults last updated at or after this RFC 3339 UTC timestamp (inclusive), e.g. 2026-01-15T12:34:56Z; the Z (UTC) offset is required.

updated_at_to
string<date-time>

Include only vaults last updated at or before this RFC 3339 UTC timestamp (inclusive), e.g. 2026-01-15T12:34:56Z; the Z (UTC) offset is required.

sort
string

Ordering as a comma-separated list of field:direction tokens (direction optional, defaults to desc). Multiple columns are applied in order. Allowed fields: id, name, created_at, updated_at. Defaults to id:desc.

resolve_policies
string

When set to true, include each vault's otc_enabled policy flag in the response. Omitted otherwise.

Response

OK. Returns the page of vaults the caller can access, with pagination total and the resolved quote asset.

result
object[]
required

Page of vaults matching the request filters.

total
integer<int32>
required

Total number of vaults matching the filters, ignoring pagination.

Example:

1

quote_asset
string
required

Quote asset code used to value the fiat balances.

Example:

"USD"