Lister les articles

Renvoie les articles de votre centre d’aide, du plus récent au plus ancien. Les articles mis à la corbeille ne sont jamais renvoyés.

GET /v1/articles

Jeton Bearer portée content:read

curl 'https://api.ferndesk.com/v1/articles?start_cursor=eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ&page_size=20&format=markdown&status=published&collection_id=col_01JXYA6ABN52&updated_since=2026-01-15T18%3A25%3A43.511Z' \
  --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "results": [
    {
      "id": "art_01JXY9AZK4KV",
      "title": "Getting started with API keys",
      "slug": "getting-started-api-keys",
      "contentHtml": "<p>Welcome to the Ferndesk API.</p>",
      "contentMarkdown": "# Welcome to the Ferndesk API",
      "contentJson": {
        "type": "doc",
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "Welcome to Ferndesk."
              }
            ]
          }
        ]
      },
      "url": "https://docs.example.com/getting-started-api-keys-A1B2C3",
      "sectionId": "sect_01JXYA4T1JNT",
      "collectionId": "col_01JXYA6ABN52",
      "status": "published",
      "layout": "default",
      "publishedAt": "2026-01-15T18:25:43.511Z",
      "createdAt": "2026-01-15T18:25:43.511Z",
      "updatedAt": "2026-01-15T18:25:43.511Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ"
}

Articles paginés par curseur

Paramètres de requête

· 6

start_cursor string

Curseur opaque issu du next_cursor de la réponse précédente.

page_size integer · min: 1· max: 100· par défaut : 20

Nombre d’éléments par page.

format string · par défaut : html· énumération

Champ du corps à renseigner : contentHtml, contentMarkdown ou le contentJson sans perte.

valeurs

html
markdown
json

status string · par défaut : published· énumération

Statut de publication à inclure ; draft et all nécessitent content:write et ne renvoient jamais les articles mis à la corbeille.

valeurs

draft
published
all

collection_id string

Limite la liste à une seule collection.

updated_since string · date-time · motif

Renvoie les articles modifiés à cet instant ou après celui-ci, du plus ancien au plus récemment modifié ; ignoré lorsqu’un start_cursor porte l’ordre.

Paramètres de requête

Réponses