Skip to content

Find the first tag with an exact name

POST
/api/v1/tag/lookup
curl --request POST \
--url https://example.com/api/v1/tag/lookup \
--header 'Content-Type: application/json' \
--data '{ "name": "example" }'

Returns at most one existing tag, choosing the smallest ID when names are duplicated. The name is case sensitive and must be normalized. This operation does not create or merge tags.

Media typeapplication/json
object
name
required

Plain-text tag name. Empty names, Unicode, punctuation, and literal markup are preserved. C0 and DEL controls are rejected. Length is measured in Unicode code points.

string
<= 5000 characters /^[^\u0000-\u001f\u007f]*$(?![\s\S])/
Examplegenerated
{
"name": "example"
}

Exact match, or an empty items array

Media typeapplication/json
object
items
required
Array<object>
<= 1 items
object
id
required

Tag ID (15 chars)

string
name
required

Tag name

string
created
string format: date-time
updated
string format: date-time
Examplegenerated
{
"items": [
{
"id": "example",
"name": "example",
"created": "2026-04-15T12:00:00Z",
"updated": "2026-04-15T12:00:00Z"
}
]
}

Invalid tag name

Tag lookup is not permitted

Internal Server Error