Labels
Org-scoped labels used to categorize changelog entries (e.g. 'release', 'security', 'performance').
Labels are short identifiers attached to changelog entries. They're useful for filtering the changelog (e.g. show only security entries) and for theming the badges your end-users see in the public-facing changelog feed.
The API lets you list labels — use the returned label ids when calling create changelog entry or filtering list changelog entries.
Labels are distinct from tags. Tags apply to feedback and roadmap posts; labels apply only to changelog entries.
The label object
A unique identifier for the label (UUID).
The display name of the label (e.g. "Release").
Auto-generated slug-like identifier (e.g. "release"). Useful for stable references in scripts.
Hex color string used as the visual badge (e.g. "#10B981").
Optional human-readable description shown in the dashboard. May be null.
ISO 8601 timestamp at which the label was created.
Example label object
{
"id": "993c3ef8-b8cd-cd15-01ba-label0000001",
"name": "Release",
"code": "release",
"color": "#10B981",
"description": "General release notes for new features and improvements.",
"created_at": "2026-03-15T09:00:00.000Z"
}
What you can do
List labels
Return every active changelog label for the authenticated organization, paginated.
Last updated 1 week ago
Built with Documentation.AI