Get list of tags - Fireblocks Developer Docs

GET

tags

TypeScript

const response: Promise<FireblocksResponse<TagsPagedResponse>> = fireblocks.tags.getTags(tagsApiGetTagsRequest);

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

Query Parameters

pageCursor

string

Page cursor to get the next page.

pageSize

number

default:100

Maximum number of items in the page

Required range: 1 <= x <= 100

label

string

Label prefix to filter by.

tagIds

string<uuid>[]

List of tag IDs to filter by.

Maximum array length: 100

includePendingApprovalsInfo

boolean

default:false

Whether to include pending approval requests info.

isProtected

boolean

type

enum<string>[]

Filter by tag type

The tag type, indicating the domain that owns the tag

Available options:

WALLET_POOL

Response

200 - application/json

Tags fetched successfully

data

object[]

required

Show child attributes

string | null

required

Cursor to the next page

Example:

"MjAyNS0wNy0wOSAxMDo1MzoxMy40NTI=:NA=="

Create a new tagCreate a new tag. Endpoint Permissions: For protected tags: ADMIN,NON_SIGNING_ADMIN,OWNER. For non protected tags: ADMIN,NON_SIGNING_ADMIN,OWNER,SIGNER,EDITOR,APPROVER.

TypeScript

const response: Promise<FireblocksResponse<TagsPagedResponse>> = fireblocks.tags.getTags(tagsApiGetTagsRequest);

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