Get a tag - Fireblocks Developer Docs

TypeScript

const response: Promise<FireblocksResponse<Tag>> = fireblocks.tags.getTag(tagsApiGetTagRequest);

{
  "id": "df4c0987-30da-4976-8dcf-bc2dd41ae331",
  "label": "VIP",
  "isProtected": false,
  "updatedAt": 1717084800000,
  "description": "Tag for VIP customers",
  "color": "#FF5733",
  "pendingApprovalRequest": {
    "id": "12345"
  }
}

Path Parameters

tagId

string<uuid>

required

The ID of the tag to retrieve

Response

200 - application/json

A tag object

string<uuid>

required

The unique identifier of the tag

Example:

"df4c0987-30da-4976-8dcf-bc2dd41ae331"

label

string

required

The tag label

Example:

"VIP"

isProtected

boolean

default:false

required

Indication if the tag is a protected tag

updatedAt

number

required

The date and time the tag was last updated

Example:

1717084800000

description

string

Description for the tag

Example:

"Tag for VIP customers"

color

string

The tag color in hex format

Example:

"#FF5733"

type

enum<string>

The tag type, indicating the domain that owns the tag

Available options:

WALLET_POOL

pendingApprovalRequest

object

Approval request details

Show child attributes

Delete a tagDelete the specified tag. Endpoint Permission: For protected tags: Owner, Admin, Non-Signing Admin. For non protected tags: Owner, Admin, Non-Signing Admin, Signer, Editor, Approver.

⌘I

TypeScript

const response: Promise<FireblocksResponse<Tag>> = fireblocks.tags.getTag(tagsApiGetTagRequest);

{
  "id": "df4c0987-30da-4976-8dcf-bc2dd41ae331",
  "label": "VIP",
  "isProtected": false,
  "updatedAt": 1717084800000,
  "description": "Tag for VIP customers",
  "color": "#FF5733",
  "pendingApprovalRequest": {
    "id": "12345"
  }
}