Skip to main content
GET
Retrieve a tag
GET /v1/tag/{tag_id} requires Tags: Read (tags.view). A successful 200 OK response contains tag.id, name, display_name, color, links_count, created_at, and updated_at. color is one of blue, green, yellow, red, purple, pink, or cyan; null represents the default gray style. Use only a workspace-scoped biq_tag_... ID; unavailable IDs return 404 resource_not_found.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.

Authorizations

Authorization
string
header
required

A workspace API key beginning with biqli_.

Path Parameters

tag
string
required
Pattern: ^biq_tag_[0-9A-HJKMNP-TV-Z]{26}$

Response

Tag.

tag
object
required
status
string
required
Allowed value: "success"