Lister les sections

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 scopes (chaque endpoint indique le scope requis 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 les brouillons d’articles, les utilisateurs et les tâches ; déplacer les articles et les collections
  • content:publish : Publier, dépublier, restaurer et placer du contenu dans la corbeille (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

  L’attribution de content:write ou content:publish implique content:read. Les clés créées avant la mise en place des scopes ont des scopes null = 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. Données de section.

  + - Show Child Attributes

  • id string

    ID de section Ferndesk (sect_...).

  • helpdeskId string

    ID du centre d’aide Ferndesk (help_...).

  • name string

    Nom d’affichage de la section.

  • isDefault boolean

    Indique si cette section est la section par défaut du centre d’aide.

  • position integer

    Position de tri utilisée pour classer les sections.

  • createdAt string

    Horodatage ISO 8601 en UTC.

  • updatedAt string

    Horodatage ISO 8601 en UTC.

  • translations[] object arraydefault

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

    + - Show Child Attributes

    • id string

      ID de l’enregistrement de traduction de la section.

    • sectionId string

      ID de section Ferndesk (sect_...).

    • language string

      Code de langue de cette traduction.

    • name string

      Nom localisé de la section.

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