API ReferenceTags

Get tag

View as Markdown

Returns a single workspace tag. Requires the tags:read scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

tag_idstringRequired

Response headers

X-RateLimit-Limitinteger

Maximum number of authenticated requests allowed for the workspace in the current 60-second window. The limit is 1000 and applies to all /api/v2 resource routes (GET, POST, PATCH, and DELETE), shared across every credential for the workspace.

X-RateLimit-Remaininginteger
Number of requests remaining in the current window before the limit is exceeded.
X-RateLimit-Resetinteger

Unix epoch seconds when the current rate-limit window resets.

ETagstringOptional
X-Api-VersionstringOptional

Response

Tag response.
objectenum
idstringformat: "^tag_[A-Za-z0-9]+$"
namestring
created_atdatetime
updated_atdatetime
hex_colorstring or nullOptionalformat: "^#[A-Fa-f0-9]{6}$"
descriptionstring or nullOptional
auto_tagging_enabledbooleanOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error