Ferndesk

Sammlungen

Eine Sammlung abrufen

Eine einzelne Sammlung mit Übersetzungen abrufen. Erfordert den Scope content:read.

Erforderlicher Scope: content:read

GET /collections/{id}

Eine Sammlung abrufen

curl --request GET \
  --url 'https://api.ferndesk.com/v1/collections/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "helpdeskId": "<string>",
  "sectionId": "<string>",
  "parentCollectionId": "<string>",
  "title": "<string>",
  "subtitle": "<string>",
  "shortId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "translations": []
}

Sammlung

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 erstellen und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt listet den erforderlichen Scope über x-required-scopes auf):

    • content:read: Hilfecenter-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: Hilfecenter-Berichte, Analysen und Artikel-Feedback lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    Die Vergabe von content:write oder content:publish beinhaltet content:read. Vor der Einführung der Scopes ausgestellte 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-Sammlungs-ID (col_...).

  • helpdeskId string

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

  • sectionId string | null

    ID des übergeordneten Abschnitts für diese Sammlung.

  • parentCollectionId string | null

    ID der übergeordneten Sammlung, wenn diese verschachtelt ist.

  • title string

    Titel der Sammlung.

  • subtitle string | null

    Optionaler Untertitel der Sammlung.

  • shortId string

    Kurze, benutzerfreundliche Kennung.

  • createdAt string

    ISO 8601-Zeitstempel in UTC.

  • updatedAt string

    ISO 8601-Zeitstempel in UTC.

  • translations[] object arraydefault

    Lokalisierte Übersetzungen der Sammlung. Default: [].

    + Show Child Attributes
    • id string

      ID des Übersetzungsdatensatzes der Sammlung.

    • collectionId string

      Ferndesk-Sammlungs-ID (col_...).

    • language string

      Sprachcode für diese Übersetzung.

    • title string

      Lokalisierter Titel der Sammlung.

    • subtitle string | null

      Lokalisierter Untertitel der Sammlung.

    • status string

      Übersetzungsstatus.

    • createdAt string

      ISO 8601-Zeitstempel in UTC.

    • updatedAt string

      ISO 8601-Zeitstempel in UTC.