Ferndesk

Artikel

Artikel nach ID abrufen

Ruft einen einzelnen Help Center-Artikel anhand seiner ID ab, einschließlich gerendertem HTML-Inhalt und seiner kanonischen URL.

GET /articles/{id}

Artikel nach ID abrufen

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

Artikel

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Keys beginnen mit dem Präfix fdsk_ und sollten geheim gehalten werden. Sie können Keys auf der Seite Entwickler-Einstellungen erstellen und verwalten.

Path Parameters

  • id string erforderlich

    Ressourcen-ID für die angeforderte Entität. Beispiel: art_01JXY9AZK4KV

Response

application/json
  • id string

    Ferndesk Artikel-ID (art_...).

  • title string

    Primärer Artikeltitel.

  • contentHtml string

    Als HTML gerenderter Artikelinhalt.

  • url string (uri) | null

    Kanonische öffentliche URL für diesen Artikel.

  • sectionId string | null

    ID des Abschnitts, der den Artikel enthält.

  • collectionId string | null

    Optionale Sammlungs-ID zur Gruppierung des Artikels.

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