Ferndesk

Sections

Lister les sections

Renvoie toutes les sections de votre centre d'aide, triées par position d'affichage. Les sections constituent la structure de navigation de premier niveau de votre centre d'aide, et chaque section inclut ses traductions disponibles.

GET /sections

Lister les sections

curl --request GET \
  --url 'https://api.ferndesk.com/v1/sections' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "items": [
    {
      "id": "<string>",
      "helpdeskId": "<string>",
      "name": "<string>",
      "isDefault": true,
      "position": 1,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "translations": []
    }
  ],
  "limit": 1,
  "offset": 1,
  "total": 1
}

Sections 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 section.

    + Show Child Attributes
    • id string

      ID de section Ferndesk (sect_...).

    • helpdeskId string

      ID de helpdesk Ferndesk (hd_...).

    • 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 l'ordonnancement des 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 pour cette traduction.

      • name string

        Nom de section localisé.

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