Changelog

Changelog entries are product updates authored in the dashboard or through the API. Reads default to published entries; writes let you manage the full lifecycle (draft, publish, archive, delete). There are two ways to show them publicly: the hosted changelog page in your help center, or your own page fed by this API.

Hosted changelog page

If your help center has the changelog turned on (Settings > Portal, Changelog module; off by default), TickOS serves a public changelog for you. Only published entries appear, newest first. When the option is off, these URLs return 404. While the help center itself is unpublished, the pages show a "coming soon" screen instead of the entries.

Entries in the public JSON feed have id, title, slug, excerpt, content_html, category, version, tags, cover_image_url and published_at.

Consuming the API on your own site

The entry object

All endpoints that return entries use the same fields. content_json is accepted on create and update but is never returned.

List entriesGET/v1/changelog

Permission: read. Returns entries for the account, newest published_at first. By default only published entries (public feed). status and category are not validated here: an unknown value returns an empty list instead of an error.

01curl -H "Authorization: Bearer sk_your_api_key" \
02  "https://api.tickos.dev/v1/changelog?status=published&limit=20"

01{
02  "data": [
03    {
04      "id": "...",
05      "title": "New block editor",
06      "slug": "new-block-editor",
07      "excerpt": "Redesigned editor with inline images.",
08      "content_html": "<h1>Editor</h1><p>...</p>",
09      "category": "feature",
10      "version": "v1.4.0",
11      "tags": [],
12      "cover_image_url": null,
13      "status": "published",
14      "published_at": "2026-10-01T12:00:00.000Z"
15    }
16  ],
17  "pagination": { "limit": 20, "offset": 0, "total": 1 }
18}

Get one entryGET/v1/changelog/{slug}

Permission: read. Returns { data: entry } for a single published entry by slug. Responds 404 if it does not exist or is not published (drafts and archived entries are not returned here).

Create an entryPOST/v1/changelog

Permission: write. All fields are optional. If status is published, published_at is stamped automatically. Returns 201 with { data: entry }.

• Slug rules on create: the slug you send (or the title) is normalized to lowercase letters, numbers and hyphens (accents removed, max 80 characters). If it is already taken in the account, a suffix is added (-2, -3...). Create never fails with 409 because of the slug; read the final slug from the response.
• Invalid category or status returns 400 with the allowed values.

01curl -X POST https://api.tickos.dev/v1/changelog \
02  -H 'Authorization: Bearer sk_your_api_key' \
03  -H 'Content-Type: application/json' \
04  -d '{
05    "title": "New block editor",
06    "excerpt": "Redesigned editor with inline images.",
07    "content_html": "<h1>Editor</h1><p>...</p>",
08    "category": "feature",
09    "version": "v1.4.0",
10    "status": "published"
11  }'

Update or change statusPATCH/v1/changelog/{slug}

Permission: write. Updates any of the create fields or changes the status (draft/published/archived) of an entry located by slug in any status. Send only the fields you want to change. Returns { data: entry }.

• Publishing stamps published_at only if the entry was never published. Re-publishing an archived or unpublished entry keeps its original published_at.
• A new slug is stored exactly as sent (it is not normalized). Returns 409 if another entry in the account already uses it.
• Invalid category or status returns 400. Unknown entry returns 404.

01# Publish
02curl -X PATCH https://api.tickos.dev/v1/changelog/new-block-editor \
03  -H 'Authorization: Bearer sk_your_api_key' \
04  -H 'Content-Type: application/json' \
05  -d '{ "status": "published" }'
06 
07# Archive (hide from the public feed)
08curl -X PATCH https://api.tickos.dev/v1/changelog/new-block-editor \
09  -H 'Authorization: Bearer sk_your_api_key' \
10  -H 'Content-Type: application/json' \
11  -d '{ "status": "archived" }'

Delete an entryDELETE/v1/changelog/{slug}

Permission: write. Permanently deletes an entry (any status) by slug within the account. Returns 404 if it does not exist.

01curl -X DELETE https://api.tickos.dev/v1/changelog/new-block-editor \
02  -H 'Authorization: Bearer sk_your_api_key'

01{
02  "deleted": true,
03  "slug": "new-block-editor"
04}