Ferndesk

Abschnitte

Abschnitt nach ID abrufen

Einen einzelnen Abschnitt anhand seiner ID abrufen, einschließlich aller verfügbaren Übersetzungen.

GET /sections/{id}

Abschnitt nach ID 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 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-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 Datensatzes der Abschnittsübersetzung.

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