Obtenir un article

Renvoie un article. Les articles non publiés sont visibles uniquement par les clés qui disposent également de content:write.

GET /v1/articles/{id}

Jeton Bearer portée content:read

curl 'https://api.ferndesk.com/v1/articles/art_01JXY9AZK4KV?format=markdown' \
  --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "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"
}

Article

Paramètres de chemin

· 1

id string requis

Identifiant de la ressource demandée.

Paramètres de requête

· 1

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

Quel champ du corps renseigner : contentHtml, contentMarkdown ou le contentJson sans perte.

valeurs

html
markdown
json

Paramètres de chemin

Paramètres de requête

Réponses