Obtenir un article

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 Developer settings.

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

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

  Accorder content:write ou content:publish implique content:read. Les clés créées avant le ciblage par portée ont des portées nulles = accès complet (mode hérité).

Path Parameters

• id string requis

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

Query Parameters

• format string enum

  Format de rendu du contenu. html (par défaut) renvoie contentHtml ; markdown renvoie contentMarkdown ; json renvoie contentJson — le document ProseMirror/Tiptap brut stocké. Le JSON utilise le schéma ProseMirror de Ferndesk (nœuds personnalisés comme callout, steps et cards) et constitue la représentation sans perte du corps de l’article. Exemple: markdown

• id string

  ID d’article Ferndesk (art_...).

• title string

  Titre principal de l’article.

• slug string | null

  Slug d’URL de l’article.

• contentHtml string

  Contenu de l’article rendu en HTML. Présent lorsque format=html (par défaut).

• contentMarkdown string

  Contenu de l’article rendu en Markdown. Présent lorsque format=markdown.

• contentJson any | null

  Document ProseMirror/Tiptap brut stocké. Présent lorsque format=json. Utilise le schéma ProseMirror de Ferndesk (nœuds personnalisés comme callout, steps, cards) et constitue la représentation sans perte.

• url string (uri) | null

  URL publique canonique de cet article.

• sectionId string | null

  ID de la section contenant l’article.

• collectionId string | null

  ID de regroupement de collection facultatif pour l’article.

• status string | null

  Statut de publication de l’article.

• publishedAt string | null

  Horodatage de la publication de l’article.

• createdAt string

  Horodatage ISO 8601 en UTC.

• updatedAt string

  Horodatage ISO 8601 en UTC.