Ferndesk

Abschnitte

Abschnitte auflisten

Gibt alle Abschnitte in Ihrem Help Center zurück, sortiert nach Anzeigeposition. Abschnitte bilden die oberste Navigationsebene Ihres Help Centers, und jeder Abschnitt enthält seine verfügbaren Übersetzungen.

GET /sections

Abschnitte auflisten

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

Paginierte Abschnitte

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 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. Abschnitts-Payload.

    + Show Child Attributes
    • id string

      Ferndesk Abschnitts-ID (sect_...).

    • helpdeskId string

      Ferndesk Helpdesk-ID (hd_...).

    • 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übersetzungs-Datensatzes.

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

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