Ferndesk

Article revisions

Get an article revision

Returns a full revision snapshot. Use format=markdown for Markdown. Requires the content:read scope.

Required scope: content:read

GET /articles/{id}/revisions/{revisionId}

Get an article revision

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/revisions/{REVISIONID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "version": 1,
  "title": "<string>",
  "source": "<string>",
  "comment": "<string>",
  "createdAt": "<string>",
  "language": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>"
}

Revision

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).

Path Parameters

  • id string required

    Ferndesk article ID (art_...). Example: art_01JXY9AZK4KV

  • revisionId string required

    Revision ID. Example: rev_01JXY9AZK4KV

Query Parameters

  • 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

Response

application/json
  • id string

    Revision ID.

  • version integer

    Article version this revision captured.

  • title string | null
  • source string | null

    Write channel of the publish.

  • comment string | null
  • createdAt string

    ISO 8601 timestamp in UTC.

  • language string

    Revision language.

  • contentHtml string
  • contentMarkdown string
  • contentJson any | null

    Raw stored ProseMirror/Tiptap revision snapshot (format=json). Lossless Ferndesk ProseMirror schema.