List articles

Returns your help center articles, newest first. Trashed articles are never returned.

GET /v1/articles

Bearer token scope content:read

curl 'https://api.ferndesk.com/v1/articles?start_cursor=eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ&page_size=20&format=markdown&status=published&collection_id=col_01JXYA6ABN52&updated_since=2026-01-15T18%3A25%3A43.511Z' \
  --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "results": [
    {
      "id": "art_01JXY9AZK4KV",
      "title": "Getting started with API keys",
      "slug": "getting-started-api-keys",
      "contentHtml": "<p>Welcome to the Ferndesk API.</p>",
      "contentMarkdown": "# Welcome to the Ferndesk API",
      "contentJson": {
        "type": "doc",
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "Welcome to Ferndesk."
              }
            ]
          }
        ]
      },
      "url": "https://docs.example.com/getting-started-api-keys-A1B2C3",
      "sectionId": "sect_01JXYA4T1JNT",
      "collectionId": "col_01JXYA6ABN52",
      "status": "published",
      "layout": "default",
      "publishedAt": "2026-01-15T18:25:43.511Z",
      "createdAt": "2026-01-15T18:25:43.511Z",
      "updatedAt": "2026-01-15T18:25:43.511Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ"
}

Cursor-paginated articles

Query parameters

· 6

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

Publish status to include; draft and all need content:write and never return trashed articles.

values

draft
published
all

collection_id string

Restricts the list to one collection.

updated_since string · date-time · pattern

Returns articles changed at or after this instant, oldest-updated first; ignored once a start_cursor carries the ordering.

Query parameters

Responses