Ferndesk

Sections

Récupérer une section par ID

Récupère une seule section par son ID, incluant toutes les traductions disponibles.

GET /sections/{id}

Récupérer une section par ID

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

Path Parameters

  • id string requis

    ID de ressource pour l'entité demandée. Exemple: art_01JXY9AZK4KV

Response

application/json
  • 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 dans le 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 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.