Ferndesk

Collections

Lister les collections

Renvoie toutes les collections de votre centre d'aide, classées de la plus récente à la plus ancienne. Les collections regroupent des articles connexes au sein d'une section, et chaque collection inclut ses traductions disponibles.

GET /collections

Lister les collections

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
}

Collections paginées

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un jeton Bearer dans l'en-tête Authorization. Les clés API sont préfixées par fdsk_ et doivent rester secrètes. Vous pouvez générer et gérer les clés depuis la page des Paramètres développeur.

Query Parameters

  • limit integer

    Nombre maximum d'éléments à renvoyer (1-100). Exemple: 20

  • offset integer

    Nombre d'éléments à ignorer avant de collecter les résultats. Exemple: 0

Response

application/json
  • items[] object array

    Éléments de la page actuelle. Charge utile de la collection.

    + Show Child Attributes
    • id string

      ID de collection Ferndesk (col_...).

    • helpdeskId string

      ID de helpdesk Ferndesk (hd_...).

    • sectionId string | null

      ID de la section parente pour cette collection.

    • parentCollectionId string | null

      ID de la collection parente si elle est imbriquée.

    • title string

      Titre de la collection.

    • subtitle string | null

      Sous-titre optionnel de la collection.

    • shortId string

      Identifiant court et lisible par l'homme.

    • createdAt string

      Horodatage ISO 8601 en UTC.

    • updatedAt string

      Horodatage ISO 8601 en UTC.

    • translations[] object arraydefault

      Traductions localisées de la collection. Default: [].

      + Show Child Attributes
      • id string

        ID de l'enregistrement de traduction de la collection.

      • collectionId string

        ID de collection Ferndesk (col_...).

      • language string

        Code de langue pour cette traduction.

      • title string

        Titre localisé de la collection.

      • subtitle string | null

        Sous-titre localisé de la collection.

      • status string

        Statut de la traduction.

      • createdAt string

        Horodatage ISO 8601 en UTC.

      • updatedAt string

        Horodatage ISO 8601 en UTC.

  • limit integer

    Taille de page utilisée pour cette réponse.

  • offset integer

    Nombre d'enregistrements ignorés pour cette page.

  • total integer

    Nombre total d'enregistrements correspondants sur toutes les pages.