FIfireblocks
Tags

Get list of tags

Retrieve a paged list of all tags according to filters.

get/tags

Request

Query parameters

pageCursorstring

Page cursor to get the next page.

pageSizenumber

Maximum number of items in the page

labelstring

Label prefix to filter by.

tagIdsstring[]

List of tag IDs to filter by.

includePendingApprovalsInfoboolean

Whether to include pending approval requests info.

isProtectedboolean
typeTagType[]

Filter by tag type

allowedEntityTypestring

Filter tags whose allow-list contains this entity type. Known values: vault_account, contact.

Response

Tags fetched successfully

nextstring nullable required

Cursor to the next page

Example response

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

Changes

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