Ferndesk

Sammlungen

Sammlungen auflisten

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

GET /collections

Sammlungen 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 Sammlungen

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.

Query Parameters

  • limit integer

    Maximale Anzahl der zurückzugebenden Elemente (1-100). Beispiel: 20

  • offset integer

    Anzahl der zu überspringenden Elemente, bevor Ergebnisse gesammelt werden. Beispiel: 0

Response

application/json
  • items[] object array

    Elemente der aktuellen Seite. Sammlungs-Payload.

    + Show Child Attributes
    • id string

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

    • helpdeskId string

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

    • sectionId string | null

      ID des übergeordneten Bereichs für diese Sammlung.

    • parentCollectionId string | null

      ID der übergeordneten Sammlung, falls 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 Sammlungsübersetzungen. Default: [].

      + Show Child Attributes
      • id string

        ID des Sammlungsübersetzungsdatensatzes.

      • collectionId string

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

      • language string

        Sprachcode für diese Übersetzung.

      • title string

        Lokalisierter Sammlungstitel.

      • subtitle string | null

        Lokalisierter Sammlungsuntertitel.

      • status string

        Übersetzungsstatus.

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