FIfireblocks
Compliance

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

Request

Query parameters

pageCursorstring
Example:eyJvZmZzZXQiOjAsInBhZ2VTaXplIjoxMH0

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

pageSizeinteger
Example:50

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

order'VAULT_OPT_OUT_LIST_ORDER_ASC' | 'VAULT_OPT_OUT_LIST_ORDER_DESC'

Sort order for the vault opt-out list by vault account id (ascending is the default when omitted).

Example:VAULT_OPT_OUT_LIST_ORDER_ASC

Sort direction by vault account id. Omit for ascending; use the enum value for descending.

Response

Page of vault opt-out rows

totalinteger required

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

nextstring

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

prevstring

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

Example response

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

Changes

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