Ferndesk

Abschnitte

Abschnitte auflisten

Gibt die Abschnitte in Ihrem Help Center zurück, nach Anzeigeposition sortiert und mit Cursor paginiert. Erfordert den Scope content:read.

Erforderlicher Scope: content:read

GET /sections

Abschnitte auflisten

curl --request GET \
  --url 'https://api.ferndesk.com/v1/sections' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "results": [
    {
      "id": "<string>",
      "helpdeskId": "<string>",
      "name": "<string>",
      "isDefault": true,
      "position": 1,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "translations": []
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Cursor-paginierte Abschnitte

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 Entwicklereinstellungen 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: Help-Center-Berichte, Analysen und Artikel-Feedback lesen
    • conversations:read: Gespräche und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

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

Query Parameters

  • page_size integer

    Anzahl der pro Seite zurückzugebenden Elemente (1–100). Beispiel: 20

  • start_cursor string

    Undurchsichtiger Cursor für die Paginierung. Übergeben Sie den next_cursor aus einer vorherigen Antwort, um die nächste Seite abzurufen. Beispiel: eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ

Response

application/json
  • results[] object array

    Elemente auf dieser Seite. Abschnitts-Payload.

    + Show Child Attributes
    • id string

      Ferndesk-Abschnitts-ID (sect_...).

    • helpdeskId string

      Ferndesk-Helpdesk-ID (help_...).

    • name string

      Anzeigename des Abschnitts.

    • isDefault boolean

      Gibt an, ob dieser Abschnitt der Standardabschnitt im Help Center ist.

    • position integer

      Sortierposition für die Reihenfolge der Abschnitte.

    • createdAt string

      ISO-8601-Zeitstempel in UTC.

    • updatedAt string

      ISO-8601-Zeitstempel in UTC.

    • translations[] object arraydefault

      Lokalisierte Abschnittsübersetzungen. Default: [].

      + Show Child Attributes
      • id string

        ID des Abschnittsübersetzungseintrags.

      • sectionId string

        Ferndesk-Abschnitts-ID (sect_...).

      • language string

        Sprachcode für diese Übersetzung.

      • name string

        Lokalisierter Abschnittsname.

      • status string

        Übersetzungsstatus.

      • createdAt string

        ISO-8601-Zeitstempel in UTC.

      • updatedAt string

        ISO-8601-Zeitstempel in UTC.

  • has_more boolean

    Gibt an, ob nach dieser Seite weitere Elemente verfügbar sind.

  • next_cursor string | null

    Cursor, der als start_cursor für die nächste Seite übergeben wird, oder null auf der letzten Seite.