List vault-level address registry opt-outs (paginated)

Lists vault accounts that are opted out of the address registry for this workspace. Pagination uses next and prev cursors from the response. If pageSize is omitted, 50 items are returned per page; allowed range is 1–100 per request.

GET /address_registry/vaults

TypeScript

TypeScript

const response: Promise<FireblocksResponse<AddressRegistryListVaultOptOutsResponse>> = fireblocks.compliance.listAddressRegistryVaultOptOuts(complianceApiListAddressRegistryVaultOptOutsRequest);

200

{
  "total": 2,
  "data": [
    {
      "vaultAccountId": 10001
    },
    {
      "vaultAccountId": 10002
    }
  ],
  "next": "eyJvZmZzZXQiOjEwLCJwYWdlU2l6ZSI6MTB9",
  "prev": ""
}

Query Parameters

pageCursor · string

Opaque cursor from a previous response (next or prev). Omit for the first page.

Example:

"eyJvZmZzZXQiOjAsInBhZ2VTaXplIjoxMH0"

pageSize · integer<int32> · default: 50

Page size. Default 50 if omitted; must be between 1 and 100.

Required range: 1 <= x <= 100

Example:

50

order · enum<string> · default: VAULT_OPT_OUT_LIST_ORDER_ASC

Sort direction by vault account id. Omit for ascending; use the enum value for descending. Sort order for the vault opt-out list by vault account id (ascending is the default when omitted).

Available options: VAULT_OPT_OUT_LIST_ORDER_ASC, VAULT_OPT_OUT_LIST_ORDER_DESC

Example:

"VAULT_OPT_OUT_LIST_ORDER_ASC"

Response

200

application/json

Page of vault opt-out rows

total · integer<int32> · required

Total number of vault accounts excluded from the address registry for your workspace.

Example:

2

data · object[] · required

Show child attributes

Example:

[
  { "vaultAccountId": 10001 },
  { "vaultAccountId": 10002 }
]

next · string

Opaque cursor for the next page; empty when there is no next page.

Example:

"eyJvZmZzZXQiOjEwLCJwYWdlU2l6ZSI6MTB9"

prev · string

Opaque cursor for the previous page; empty when there is no previous page.

Example:

""