Announcements

Announcements are published changelog entries. Use this endpoint to fetch news and product updates for your own apps or newsletters.

List announcements

GET /api/v1/announcements/

Retrieve a paginated list of published announcements.

Query parameters

Parameter	Type	Required	Default	Description
`limit`	integer	No	20	Results per page (max 100).
`offset`	integer	No	0	Number of results to skip.
`category_id`	integer	No	-	Filter by category ID.
`search`	string	No	-	Search title and content.

Example request

curl -sS \
  -H 'Authorization: Api-Key scalar*live*...' \
  'https://<your-host>/api/v1/announcements/?limit=10'

Success response (200 OK)

{
    "results": [
        {
            "id": 42,
            "title": "New Feature: Dark Mode",
            "content": "We're excited to announce...",
            "category": {
                "name": "Product Updates",
                "colour": "#8B5CF6"
            },
            "published_at": "2025-01-15T10:00:00Z",
            "is_pinned": true,
            "reaction_count": 25,
            "slug": "new-feature-dark-mode-abc123"
        }
    ],
    "count": 1
}

Objects

Announcement object

Field	Type	Description
`id`	integer	Unique internal ID.
`title`	string	Announcement title.
`content`	string	Full HTML or Markdown content.
`category`	object	Category object.
`published_at`	datetime	ISO 8601 publication timestamp.
`is_pinned`	boolean	Whether the announcement is pinned to the top.
`reaction_count`	integer	Total number of customer reactions.
`slug`	string	URL-safe identifier.

Category object

Field	Type	Description
`name`	string	Category name.
`colour`	string	Hex display colour.