Ferndesk

Sections

Obtenir une section

Récupérer une seule section avec ses traductions. Nécessite la portée content:read.

Portée requise : content:read

GET /sections/{id}

Obtenir une section

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

Section

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 les brouillons d’articles, les utilisateurs et les tâches ; déplacer les articles et les collections
    • content:publish : Publier, dépublier, restaurer et supprimer définitivement le contenu (rendre les modifications effectives)
    • analytics:read : Lire les rapports, les analyses et les retours sur les articles du centre d’aide
    • conversations:read : Lire les conversations et les transcriptions de l’assistant IA
    • webhooks:manage : Créer et gérer les abonnements aux webhooks sortants

    L’octroi de 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 disposent d’un accès complet (mode hérité).

Path Parameters

  • id string requis

    Identifiant de ressource de l’entité demandée. Exemple: art_01JXY9AZK4KV

Response

application/json
  • id string

    Identifiant de section Ferndesk (sect_...).

  • helpdeskId string

    Identifiant de 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 l’ordre 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

      Identifiant de l’enregistrement de traduction de la section.

    • sectionId string

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