Changelog API

Returns published changelogs for the project.

Changelog endpoints return 404 when the project's public changelog is disabled.

List Changelogs

GET v1/changelog

Returns published changelogs for list views.

Authentication

No authentication required.

Response

{
  "data": [
    {
      "slug": "v2-0-release",
      "name": "v2.0 Release",
      "title": "v2.0 Release",
      "version": "2.0.0",
      "type": "release",
      "status": "published",
      "cover_image": "https://cdn.example.com/cover.jpg",
      "tags": ["major", "ui"],
      "publish_date": "2024-03-01T00:00:00.000000Z",
      "created_at": "2024-03-01T00:00:00.000000Z",
      "updated_at": "2024-03-01T00:00:00.000000Z",
      "short_description": "<p>Release notes preview...</p>"
    }
  ],
  "versions": ["1.0.0", "2.0.0"],
  "types": ["bugfix", "release"],
  "project": {
    "slug": "my-project",
    "name": "My Project",
    "logo_url": "https://cdn.example.com/logo.png",
    "brand_color": "#3b82f6",
    "brand_text_color": null
  }
}

---

Show Changelog

GET v1/changelog/{changelogSlug}

Returns one published changelog with full rendered content.

Authentication

No authentication required.

Response

{
  "changelog": {
    "slug": "v2-0-release",
    "name": "v2.0 Release",
    "title": "v2.0 Release",
    "version": "2.0.0",
    "type": "release",
    "status": "published",
    "cover_image": "https://cdn.example.com/cover.jpg",
    "tags": ["major"],
    "publish_date": "2024-03-01T00:00:00.000000Z",
    "created_at": "2024-03-01T00:00:00.000000Z",
    "updated_at": "2024-03-01T00:00:00.000000Z",
    "content": "<p>Release notes in HTML...</p>"
  },
  "navigation": {
    "previous": {
      "title": "v1.9 Hotfix",
      "slug": "v1-9-hotfix",
      "version": "1.9.1",
      "cover_image": null
    },
    "next": null
  },
  "project": {
    "slug": "my-project",
    "name": "My Project",
    "logo_url": "https://cdn.example.com/logo.png",
    "brand_color": "#3b82f6",
    "brand_text_color": null
  }
}

The content field is rendered HTML.