FIfireblocks
Vaults

Get vault accounts (Paginated)

Gets all vault accounts in your workspace. This endpoint returns a limited amount of results with a quick response time. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

get/vault/accounts_paged

Request

Query parameters

namePrefixstring
nameSuffixstring
minAmountThresholdnumber
Example:10

Specifying minAmountThreshold will filter accounts whose total balance is greater than this value; otherwise, it returns all accounts. The amount set in this parameter represents the native asset amount, not its USD value.

assetIdstring
orderBy'ASC' | 'DESC'
beforestring
afterstring
limitnumber
tagIdsstring[]

DEPRECATED - use includeTagIds instead

includeTagIdsstring[]

List of tag IDs to include. Vault accounts with any of these tags will be included

excludeTagIdsstring[]

List of tag IDs to exclude. Vault accounts with any of these tags will be filtered out

Response

A VaultAccountsPagedResponse object

previousUrlstring
nextUrlstring

Example response

{
  "accounts": [
    {
      "tags": [
        {
          "id": "df4c0987-30da-4976-8dcf-bc2dd41ae331",
          "label": "VIP",
          "description": "Tag for VIP customers",
          "color": "#FF5733",
          "updatedAt": 1717084800000,
          "allowedEntityTypes": [
            "vault_account"
          ],
          "pendingApprovalRequest": {
            "id": "12345"
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.