Ferndesk

Artikel

Artikel auflisten

Gibt alle Help Center-Artikel für Ihre Organisation zurück, sortiert von neu nach alt. Jeder Artikel enthält gerenderten HTML-Inhalt und eine kanonische URL für Ihr Help Center.

GET /articles

Artikel auflisten

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

Paginierte Artikel-Antwort

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 Schlüssel auf der Seite Entwickler-Einstellungen generieren und verwalten.

Query Parameters

  • limit integer

    Maximale Anzahl der zurückzugebenden Elemente (1-100). Beispiel: 20

  • offset integer

    Anzahl der zu überspringenden Elemente vor dem Sammeln der Ergebnisse. Beispiel: 0

Response

application/json
  • items[] object array

    Elemente der aktuellen Seite. Artikel-Payload, die von Artikel-Endpunkten zurückgegeben wird.

    + Show Child Attributes
    • 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 Bereichs, der den Artikel enthält.

    • collectionId string | null

      Optionale Sammlungs-Gruppierungs-ID für den Artikel.

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

  • limit integer

    Für diese Antwort verwendete Seitengröße.

  • offset integer

    Anzahl der übersprungenen Datensätze für diese Seite.

  • total integer

    Gesamtzahl der übereinstimmenden Datensätze über alle Seiten hinweg.