Ferndesk

Articles

Lister les articles

Retourne tous les articles du centre d'aide de votre organisation, classés du plus récent au plus ancien. Chaque article inclut le contenu HTML rendu et une URL canonique pour votre centre d'aide.

GET /articles

Lister les articles

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

Réponse d'article paginée

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 à retourner (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 l'article retournée par les points de terminaison d'article.

    + Show Child Attributes
    • 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 de regroupement de collection optionnel pour l'article.

    • status string | null

      Statut de publication de l'article.

    • publishedAt string | null

      Horodatage de publication de l'article.

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