Skip to main content
Retrieve a tag

Authorizations

Authorization
string
header
required

A Tightknit admin API key, sent as Authorization: Bearer <key>.

Path Parameters

tag_id
string
required

The tag's id.

Pattern: ^tags_[a-zA-Z0-9]{12}$

Query Parameters

expand

Repeatable. Returns the named relation inline. One of: created_by, updated_by.

Available options:
created_by,
updated_by

Response

Success

object
enum<string>
required

Always tag.

Available options:
tag
id
string
required

Unique identifier for the object.

Example:

"tags_4h2o89z6qlpw"

created_at
string<date-time>
required

When the object was created.

updated_at
string<date-time>
required

When the object was last changed.

label
string
required

The name the tag is shown with.

slug
string
required

A URL-safe name, made from the label when none is set. Renaming the label keeps it.

section
string | null
required

Free text that subdivides a tag group, not a fixed vocabulary: a group holds at most 10 distinct sections, and a tag with none reads null.

Example:

"format"

description
string | null
required

What the tag is for. Null when not set.

tag_group_id
string
required

The id of the tag group the tag belongs to.

Example:

"tgrp_4h2o89z6qlpw"

created_by_id
string | null
required

The id of the member who created the tag. Null when no member is recorded as its creator.

Example:

"prof_5Yq7tVz2Hm3n"

updated_by_id
string | null
required

The id of the member who last changed the tag. Null until it is first changed, or when no member is recorded.

Example:

"prof_5Yq7tVz2Hm3n"

created_by
object | null

The member who created the tag. Present only when created_by is expanded.

updated_by
object | null

The member who last changed the tag. Present only when updated_by is expanded.