Skip to main content
Retrieve a tag group

Authorizations

Authorization
string
header
required

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

Path Parameters

tag_group_id
string
required

The tag group's id.

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

Query Parameters

expand

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

Available options:
tags,
created_by,
updated_by

Response

Success

object
enum<string>
required

Always tag_group.

Available options:
tag_group
id
string
required

Unique identifier for the object.

Example:

"tgrp_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 group is shown with.

slug
string
required

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

description
string | null
required

What the tag group is for. Null when not set.

emoji_icon
string | null
required

The emoji shown beside the tag group. Null when it has none.

visibility
enum<string>
required

Who sees the tag group and its tags. One of:

  • public: members, wherever tags show on the community site.
  • internal: hidden from members; only people who can manage tags see them, through Studio, MCP and this API.
Available options:
public,
internal
Example:

"public"

created_by_id
string | null
required

The id of the member who created the tag group. 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 group. 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 group. Present only when created_by is expanded.

updated_by
object | null

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

tags
object[]

The tags in the group. Present only when tags is expanded.