Ferndesk

Abschnitte

Einen Abschnitt abrufen

Einen einzelnen Abschnitt mit Übersetzungen abrufen. Erfordert den Scope content:read.

Erforderlicher Scope: content:read

GET /sections/{id}

Einen Abschnitt abrufen

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

Abschnitt

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel haben das Präfix 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: Hilfezentrum-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, Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Hilfezentrums lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

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

Path Parameters

  • id string erforderlich

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

Response

application/json
  • id string

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

  • helpdeskId string

    Ferndesk-Hilfezentrum-ID (help_...).

  • name string

    Anzeigename des Abschnitts.

  • isDefault boolean

    Gibt an, ob dieser Abschnitt der Standardabschnitt im Hilfezentrum 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übersetzungsdatensatzes.

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