Ferndesk

Kollektionen

Kollektionen auflisten

Gibt alle Kollektionen in Ihrem Help Center zurück, sortiert von neu nach alt. Kollektionen gruppieren verwandte Artikel innerhalb eines Bereichs, und jede Kollektion enthält ihre verfügbaren Übersetzungen.

GET /collections

Kollektionen auflisten

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

Paginierte Kollektionen

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern einen 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 erstellen 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. Kollektions-Payload.

    + Show Child Attributes
    • id string

      Ferndesk Kollektions-ID (col_...).

    • helpdeskId string

      Ferndesk Helpdesk-ID (hd_...).

    • sectionId string | null

      ID des übergeordneten Bereichs für diese Kollektion.

    • parentCollectionId string | null

      ID der übergeordneten Kollektion, falls verschachtelt.

    • title string

      Titel der Kollektion.

    • subtitle string | null

      Optionaler Untertitel der Kollektion.

    • shortId string

      Kurze, benutzerfreundliche Kennung.

    • createdAt string

      ISO 8601 Zeitstempel in UTC.

    • updatedAt string

      ISO 8601 Zeitstempel in UTC.

    • translations[] object arraydefault

      Lokalisierte Kollektions-Übersetzungen. Default: [].

      + Show Child Attributes
      • id string

        ID des Datensatzes der Kollektions-Übersetzung.

      • collectionId string

        Ferndesk Kollektions-ID (col_...).

      • language string

        Sprachcode für diese Übersetzung.

      • title string

        Lokalisierter Kollektionstitel.

      • subtitle string | null

        Lokalisierter Kollektionsuntertitel.

      • status string

        Status der Übersetzung.

      • 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 passenden Datensätze über alle Seiten hinweg.