Ferndesk

Sammlungen

Sammlungen auflisten

Gibt die Sammlungen in Ihrem Hilfezentrum zurück, neueste zuerst, cursor-paginiert. Erfordert den Scope content:read.

Erforderlicher Scope: content:read

GET /collections

Sammlungen auflisten

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

Cursor-paginierte Sammlungen

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 führt den erforderlichen Scope über x-required-scopes auf):

    • content:read: Hilfezentrumsartikel, 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 löschen (Ä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

    Die Vergabe von content:write oder content:publish beinhaltet content:read. Vor der Einführung von 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

    Opaker Cursor für die Seitennavigation. Ü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. Sammlungsobjekt.

    + Show Child Attributes
    • id string

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

    • helpdeskId string

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

    • sectionId string | null

      Übergeordnete Abschnitts-ID dieser Sammlung.

    • parentCollectionId string | null

      Übergeordnete Sammlungs-ID, wenn diese verschachtelt ist.

    • title string

      Titel der Sammlung.

    • subtitle string | null

      Optionaler Untertitel der Sammlung.

    • shortId string

      Kurze, menschenfreundliche 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 Sammlung-Übersetzungsdatensatzes.

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

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