Retrieve all vaults belonging to your organization. Results are returned in a paginated envelope containing a data array of vaults and a pagination object.
| Parameter | Type | Description |
|---|---|---|
page | number | Page number for pagination (starts at 1) |
limit | number | Number of items per page |
status | string | Filter by vault status: active, inactive, or all (default active) |
The response is a paginated envelope with data (array of vaults) and pagination (see Pagination Response below). Each vault in data includes:
| Field | Type | Description |
|---|---|---|
id | UUID | Unique vault identifier |
name | string | Human-readable vault name |
type | enum | Vault type — HSM |
status | enum | Vault status - active or inactive |
keyStatus | enum | Key generation status - ready, pending, or failed |
keyError | string | Error message if key generation failed (nullable) |
userId | UUID | ID of user who created the vault |
organizationId | UUID | Organization ID that owns the vault |
address | string | Ethereum-compatible blockchain address (0x...) |
bsb | string | Bank State Branch code (for fiat integrations, nullable) |
accountNumber | string | Bank account number (for fiat integrations, nullable) |
groupName | string | Optional grouping label for organizing vaults (nullable) |
tags | string[] | Array of string tags for filtering |
createdAt | datetime | Creation timestamp (ISO 8601, UTC) |
updatedAt | datetime | Last modification timestamp (ISO 8601, UTC) |
assets | array | Array of asset balances associated with this vault |
user | object | Nested user object containing user id |
| Field | Type | Description |
|---|---|---|
page | number | Current page number |
limit | number | Items per page |
total | number | Total number of vaults |
totalPages | number | Total number of pages |
hasNext | boolean | Whether more pages exist |
hasPrev | boolean | Whether previous pages exist |
vaults:read
Retrieve all vaults belonging to your organization. Results are returned in a paginated envelope containing a data array of vaults and a pagination object.
| Parameter | Type | Description |
|---|---|---|
page | number | Page number for pagination (starts at 1) |
limit | number | Number of items per page |
status | string | Filter by vault status: active, inactive, or all (default active) |
The response is a paginated envelope with data (array of vaults) and pagination (see Pagination Response below). Each vault in data includes:
| Field | Type | Description |
|---|---|---|
id | UUID | Unique vault identifier |
name | string | Human-readable vault name |
type | enum | Vault type — HSM |
status | enum | Vault status - active or inactive |
keyStatus | enum | Key generation status - ready, pending, or failed |
keyError | string | Error message if key generation failed (nullable) |
userId | UUID | ID of user who created the vault |
organizationId | UUID | Organization ID that owns the vault |
address | string | Ethereum-compatible blockchain address (0x...) |
bsb | string | Bank State Branch code (for fiat integrations, nullable) |
accountNumber | string | Bank account number (for fiat integrations, nullable) |
groupName | string | Optional grouping label for organizing vaults (nullable) |
tags | string[] | Array of string tags for filtering |
createdAt | datetime | Creation timestamp (ISO 8601, UTC) |
updatedAt | datetime | Last modification timestamp (ISO 8601, UTC) |
assets | array | Array of asset balances associated with this vault |
user | object | Nested user object containing user id |
| Field | Type | Description |
|---|---|---|
page | number | Current page number |
limit | number | Items per page |
total | number | Total number of vaults |
totalPages | number | Total number of pages |
hasNext | boolean | Whether more pages exist |
hasPrev | boolean | Whether previous pages exist |
vaults:read