Fireblocks Tags API.
Provides CRUD operations for workspace tags and tag approval request management. Tags can be attached to vault accounts to organize and group them.
Summary
Functions
Cancels a pending tag approval request.
Creates a new tag in the workspace.
Deletes a tag from the workspace by its ID.
Retrieves a single tag approval request by its numeric ID.
Retrieves a single tag by its ID.
Returns a paginated list of all tags in the workspace, filtered by optional criteria.
Updates an existing tag's label or description.
Functions
Cancels a pending tag approval request.
Only PENDING approval requests can be cancelled. Returns 202 Accepted on success.
id: Numeric string ID of the approval request to cancel
Creates a new tag in the workspace.
Options:
:label(String.t/0) - Required. The tag label (2–30 characters):description(String.t/0) - Tag description (max 250 characters):color(String.t/0) - Hex color code (e.g.#FF5733):isProtected(boolean/0) - Whether the tag is protected from modification by non-owners The default value isfalse.
Deletes a tag from the workspace by its ID.
tag_id: UUID of the tag to delete
Retrieves a single tag approval request by its numeric ID.
id: Numeric string ID of the approval request
Retrieves a single tag by its ID.
tag_id: UUID of the tag to retrieve
Returns a paginated list of all tags in the workspace, filtered by optional criteria.
Options:
:pageCursor(String.t/0) - Page cursor for the next page of results:pageSize(non_neg_integer/0) - Number of results per page (1–100, default 100):label(String.t/0) - Filter tags by label prefix:tagIds(list ofString.t/0) - Filter by specific tag IDs (max 100 UUIDs):includePendingApprovalsInfo(boolean/0) - Include pending approval info in results The default value isfalse.:isProtected(boolean/0) - Filter by tag protection status
Updates an existing tag's label or description.
tag_id: UUID of the tag to update
Options:
:label(String.t/0) - The tag label:description(String.t/0) - Tag description