List changelog entries

Returns the entries of a changelog by the date they show, newest first. Drafts without a date sort by when they were created.

GET /v1/changelogs/{id}/entries

Bearer token scope content:read

curl 'https://api.ferndesk.com/v1/changelogs/art_01JXY9AZK4KV/entries?start_cursor=eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ&page_size=20&format=markdown&status=published' \
  --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "results": [
    {
      "id": "art_01JXY9AZK4KV",
      "changelogId": "col_01JXYA6ABN52",
      "title": "Faster search",
      "slug": "faster-search",
      "contentHtml": "<p>Search results now load twice as fast.</p>",
      "contentMarkdown": "Search results now load twice as fast.",
      "contentJson": {
        "type": "doc",
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "Welcome to Ferndesk."
              }
            ]
          }
        ]
      },
      "url": "https://docs.example.com/faster-search-A1B2C3",
      "status": "published",
      "date": "2026-09-30",
      "tags": [
        "new"
      ],
      "announce": false,
      "publishedAt": "2026-09-30T14:02:11.000Z",
      "createdAt": "2026-01-15T18:25:43.511Z",
      "updatedAt": "2026-01-15T18:25:43.511Z",
      "draft": {
        "id": "drft_01JXY9AZK4KV",
        "title": "Faster search",
        "contentHtml": "<p>Search results now load twice as fast.</p>",
        "contentMarkdown": "Search results now load twice as fast.",
        "contentJson": {
          "type": "doc",
          "content": [
            {
              "type": "paragraph",
              "content": [
                {
                  "type": "text",
                  "text": "Welcome to Ferndesk."
                }
              ]
            }
          ]
        },
        "source": "api",
        "updatedAt": "2026-01-15T18:25:43.511Z"
      }
    }
  ],
  "has_more": true,
  "next_cursor": "eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ"
}

Cursor-paginated entries

Path parameters

· 1

id string required

Identifier of the requested resource.

Query parameters

· 4

start_cursor string

Opaque cursor taken from the previous response’s next_cursor.

page_size integer · min: 1· max: 100· default: 20

Items per page.

format string · default: html· enum

Which body field to populate: contentHtml, contentMarkdown, or the lossless contentJson.

values

html
markdown
json

status string · default: published· enum

Which entries to include; draft and all need content:write.

values

draft
published
all

Path parameters

Query parameters

Responses