Ferndesk

Articles

Obtenir un article par son ID

Récupérer un seul article du centre d'aide par son ID, incluant le contenu HTML rendu et son URL canonique.

GET /articles/{id}

Obtenir un article par son ID

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "title": "<string>",
  "contentHtml": "<string>",
  "url": "<url>",
  "sectionId": "<string>",
  "collectionId": "<string>",
  "status": "<string>",
  "publishedAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

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 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 d'article Ferndesk (art_...).

  • title string

    Titre principal de l'article.

  • contentHtml string

    Contenu de l'article rendu en HTML.

  • url string (uri) | null

    URL publique canonique pour cet article.

  • sectionId string | null

    ID de la section contenant l'article.

  • collectionId string | null

    ID optionnel du groupe de collection 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.