Ferndesk

Sammlungen

Sammlung nach ID abrufen

Ruft eine einzelne Sammlung anhand ihrer ID ab, einschließlich aller verfügbaren Übersetzungen.

GET /collections/{id}

Sammlung nach ID 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 dem 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 Sammlungs-ID (col_...).

  • helpdeskId string

    Ferndesk Helpdesk-ID (hd_...).

  • 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 Übersetzungen der Sammlung. Default: [].

    + Show Child Attributes
    • id string

      ID des Datensatzes der Sammlungsübersetzung.

    • 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

      Status der Übersetzung.

    • createdAt string

      ISO 8601 Zeitstempel in UTC.

    • updatedAt string

      ISO 8601 Zeitstempel in UTC.