Changelog

Full CRUD over your project’s changelog entries.

GET/v1/changelog

Parameter	Type	Description
`locale`	`string`	Return entries in this locale when a translation exists.
`limit`	`integer`	Page size. Defaults to 20.
`offset`	`integer`	Number of items to skip. Defaults to 0.

Listing returns published entries only — the same set a portal visitor sees.

GET/v1/changelog/:id

Parameter	Type	Description
`locale`	`string`	Return the entry in this locale when a translation exists.

POST/v1/changelog

Parameter	Type	Description
`title`required	`string`	Entry title.
`body`	`string`	Entry body (Markdown).
`labels`	`string[]`	Labels such as New, Improved, Fixed.
`version`	`string`	Semver version. Defaults to 1.0.0.
`status`	`string`	draft, scheduled, or published. Defaults to draft.
`locale`	`string`	Locale of the content. Defaults to en.

PATCH/v1/changelog/:id

Parameter	Type	Description
`title`	`string`	Entry title.
`body`	`string`	Entry body (Markdown).
`labels`	`string[]`	Labels such as New, Improved, Fixed.
`version`	`string`	Semver version. Defaults to 1.0.0.
`status`	`string`	draft, scheduled, or published. Defaults to draft.
`locale`	`string`	Locale of the content. Defaults to en.

DELETE/v1/changelog/:id

Writes require paid-plan API access Pro. DELETE returns 204 with an empty body.

List changelog entries


curl "https://api.supdesk.app/v1/changelog?locale=en&limit=20" \
  -H "Authorization: Bearer sd_live_..."


{
  "data": [
    {
      "id": "ch_abc123",
      "title": "Version 1.4.0",
      "body": "### New Features\n\n- Added dark mode support\n- New export options\n\n### Fixes\n\n- Fixed Safari export button issue",
      "labels": ["new", "fixed"],
      "published_at": "2026-07-01T12:00:00Z",
      "locale": "en",
      "version": "1.4.0"
    }
  ],
  "pagination": { "limit": 20, "offset": 0, "has_more": false }
}

Get a changelog entry


curl "https://api.supdesk.app/v1/changelog/ch_abc123?locale=en" \
  -H "Authorization: Bearer sd_live_..."


{
  "data": {
    "id": "ch_abc123",
    "title": "Version 1.4.0",
    "body": "### New Features\n\n- Added dark mode support\n- New export options\n\n### Fixes\n\n- Fixed Safari export button issue",
    "labels": ["new", "fixed"],
    "published_at": "2026-07-01T12:00:00Z",
    "locale": "en",
    "version": "1.4.0"
  }
}

Create a changelog entry


curl -X POST https://api.supdesk.app/v1/changelog \
  -H "Authorization: Bearer sd_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Version 1.4.0",
    "body": "### New Features\n\n- Added dark mode support\n- New export options\n\n### Fixes\n\n- Fixed Safari export button issue",
    "labels": ["new", "fixed"],
    "version": "1.4.0",
    "status": "published",
    "locale": "en"
  }'


{
  "data": {
    "id": "ch_abc123",
    "title": "Version 1.4.0",
    "body": "### New Features\n\n- Added dark mode support\n- New export options\n\n### Fixes\n\n- Fixed Safari export button issue",
    "labels": ["new", "fixed"],
    "published_at": "2026-07-01T12:00:00Z",
    "locale": "en",
    "version": "1.4.0"
  }
}

Update a changelog entry


curl -X PATCH https://api.supdesk.app/v1/changelog/ch_abc123 \
  -H "Authorization: Bearer sd_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Version 1.4.0 - Enhanced",
    "status": "draft"
  }'


{
  "data": {
    "id": "ch_abc123",
    "title": "Version 1.4.0 - Enhanced",
    "body": "### New Features\n\n- Added dark mode support\n- New export options\n\n### Fixes\n\n- Fixed Safari export button issue",
    "labels": ["new", "fixed"],
    "published_at": null,
    "locale": "en",
    "version": "1.4.0"
  }
}

Delete a changelog entry


curl -X DELETE https://api.supdesk.app/v1/changelog/ch_abc123 \
  -H "Authorization: Bearer sd_live_..."

Returns 204 No Content on success.