Ferndesk

Artikel

Einen Artikel abrufen

Einen einzelnen veröffentlichten Help-Center-Artikel anhand seiner ID abrufen. Verwenden Sie format=markdown für Markdown-Inhalte.

Erforderlicher Scope: content:read

GET /articles/{id}

Einen Artikel abrufen

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "title": "<string>",
  "slug": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>",
  "url": "<url>",
  "sectionId": "<string>",
  "collectionId": "<string>",
  "status": "<string>",
  "publishedAt": "<string>",
  "createdAt": "<string>"
}

Artikel

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel beginnen mit fdsk_ und sollten geheim gehalten werden. Sie können Schlüssel auf der Seite Developer settings generieren und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt führt den erforderlichen Scope über x-required-scopes auf):

    • content:read: Help-Center-Artikel, Sammlungen, Abschnitte und Übersetzungen lesen und durchsuchen
    • content:write: Artikelentwürfe, Benutzer und Aufgaben erstellen und bearbeiten; Artikel und Sammlungen verschieben
    • content:publish: Inhalte veröffentlichen, deren Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Help Centers lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    Die Vergabe von content:write oder content:publish beinhaltet content:read. Vor der Einführung von Scopes ausgestellte Schlüssel haben null Scopes = vollständigen Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

    Ressourcen-ID der angeforderten Entität. Beispiel: art_01JXY9AZK4KV

Query Parameters

  • format string enum

    Format für die Inhaltsdarstellung. html (Standard) gibt contentHtml zurück; markdown gibt contentMarkdown zurück; json gibt contentJson zurück – das unveränderte gespeicherte ProseMirror/Tiptap-Dokument. Das JSON verwendet das ProseMirror-Schema von Ferndesk (benutzerdefinierte Knoten wie callout, steps und cards) und ist die verlustfreie Darstellung des Artikelinhalts. Beispiel: markdown

Response

application/json
  • id string

    Ferndesk article ID (art_...).

  • title string

    Primärer Artikeltitel.

  • slug string | null

    URL-Slug für den Artikel.

  • contentHtml string

    Als HTML dargestellter Artikelinhalt. Vorhanden, wenn format=html (Standard) verwendet wird.

  • contentMarkdown string

    Als Markdown dargestellter Artikelinhalt. Vorhanden, wenn format=markdown verwendet wird.

  • contentJson any | null

    Unverändertes gespeichertes ProseMirror/Tiptap-Dokument. Vorhanden, wenn format=json verwendet wird. Verwendet das ProseMirror-Schema von Ferndesk (benutzerdefinierte Knoten wie callout, steps, cards) und ist die verlustfreie Darstellung.

  • url string (uri) | null

    Kanonische öffentliche URL für diesen Artikel.

  • sectionId string | null

    Abschnitts-ID, die den Artikel enthält.

  • collectionId string | null

    Optionale ID der Sammlung, zu der der Artikel gruppiert ist.

  • status string | null

    Veröffentlichungsstatus des Artikels.

  • publishedAt string | null

    Zeitstempel der Veröffentlichung des Artikels.

  • createdAt string

    ISO 8601-Zeitstempel in UTC.

  • updatedAt string

    ISO 8601-Zeitstempel in UTC.