Lister les collections

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 Paramètres développeur.

  Les clés peuvent être limitées à n'importe quel sous-ensemble de ces portées (chaque endpoint indique la portée requise via x-required-scopes) :

  • content:read : Lire et rechercher les articles, collections, sections et traductions du centre d'aide
  • content:write : Créer et modifier des brouillons d'articles, des utilisateurs et des tâches ; déplacer des articles et des collections
  • content:publish : Publier, dépublier, restaurer et mettre à la corbeille du contenu (rendre les modifications visibles)
  • analytics:read : Lire les rapports, analyses et retours sur les articles du centre d'aide
  • conversations:read : Lire les conversations et transcriptions de l'assistant IA
  • webhooks:manage : Créer et gérer les abonnements aux webhooks sortants

  Accorder content:write ou content:publish implique content:read. Les clés créées avant la mise en place des portées ont des portées nulles et un accès complet (mode hérité).

Query Parameters

• page_size integer

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

• start_cursor string

  Curseur de pagination opaque. Transmettez le next_cursor d'une réponse précédente pour récupérer la page suivante. Exemple: eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ

• results[] object array

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

  + - Show Child Attributes

  • id string

    ID de collection Ferndesk (col_...).

  • helpdeskId string

    ID du helpdesk Ferndesk (help_...).

  • sectionId string | null

    ID de la section parente de cette collection.

  • parentCollectionId string | null

    ID de la collection parente si celle-ci est imbriquée.

  • title string

    Titre de la collection.

  • subtitle string | null

    Sous-titre facultatif de la collection.

  • shortId string

    Identifiant court convivial.

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

• has_more boolean

  Indique si d'autres éléments sont disponibles après cette page.

• next_cursor string | null

  Curseur à transmettre comme start_cursor pour la page suivante, ou null sur la dernière page.