List articles

Authorizations

• Authorization string required header

  All requests require a Bearer token in the Authorization header. API keys are prefixed with fdsk_ and should be kept secret. You can generate and manage keys from the Developer settings page.

  Keys can be restricted to any subset of these scopes (each endpoint lists the scope it requires via x-required-scopes):

  • content:read: Read and search help center articles, collections, sections, and translations
  • content:write: Create and edit article drafts, users, tasks; move articles and collections
  • content:publish: Publish, unpublish, restore, and trash content (make changes live)
  • analytics:read: Read help center reporting, analytics, and article feedback
  • conversations:read: Read AI assistant conversations and transcripts
  • webhooks:manage: Create and manage outbound webhook subscriptions

  Granting content:write or content:publish implies content:read. Keys minted before scoping have null scopes = full access (legacy mode).

Query Parameters

• collection_id string

  Only return articles in this collection. Example: col_01JXYA6ABN52

• format string enum

  Content rendering format. html (default) returns contentHtml; markdown returns contentMarkdown; json returns contentJson — the raw stored ProseMirror/Tiptap document. The JSON uses Ferndesk’s ProseMirror schema (custom nodes like callout, steps, and cards) and is the lossless representation of the article body. Example: markdown

• page_size integer

  Number of items to return per page (1-100). Example: 20

• start_cursor string

  Opaque pagination cursor. Pass the next_cursor from a previous response to fetch the next page. Example: eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ

• status string enum

  Filter by publish status. Defaults to published. draft and all require the content:write scope and never include trashed articles. Example: published

• updated_since string (date-time)

  Only return articles updated at or after this ISO 8601 timestamp. Use for incremental sync. Example: 2026-01-15T18:25:43.511Z

• results[] object array

  Items in this page. Article payload returned by article endpoints.

  + - Show Child Attributes

  • id string

    Ferndesk article ID (art_...).

  • title string

    Primary article title.

  • slug string | null

    URL slug for the article.

  • contentHtml string

    Article content rendered as HTML. Present when format=html (default).

  • contentMarkdown string

    Article content rendered as Markdown. Present when format=markdown.

  • contentJson any | null

    Raw stored ProseMirror/Tiptap document. Present when format=json. Uses Ferndesk’s ProseMirror schema (custom nodes like callout, steps, cards) and is the lossless representation.

  • url string (uri) | null

    Canonical public URL for this article.

  • sectionId string | null

    Section ID containing the article.

  • collectionId string | null

    Optional collection grouping ID for the article.

  • status string | null

    Article publish status.

  • publishedAt string | null

    Timestamp when the article was published.

  • createdAt string

    ISO 8601 timestamp in UTC.

  • updatedAt string

    ISO 8601 timestamp in UTC.

• has_more boolean

  Whether more items are available after this page.

• next_cursor string | null

  Cursor to pass as start_cursor for the next page, or null on the last page.