Consultez vos centres d'aide avec l'API Notiondesk

L'API Notiondesk vous permet de lister tous les centres d'aide de votre espace de travail, de consulter leur configuration et de vérifier l'état de leur synchronisation Notion planifiée. Commencez ici : le centre d'aide id renvoyé par ces routes est celui site_id emprunté par toutes les autres routes de l'API Notiondesk.

Dans l'API Notiondesk, un centre d'aide est appelé un site .

Dressez la liste de vos centres d'aide

La liste comprend tous les centres d'aide de l'espace de travail qui possèdent votre clé, du plus ancien au plus récent, en utilisant la pagination par curseur avec page_size et cursor.

curl "https://api.notiondesk.so/sites?page_size=50" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
      "full_domain": "help.example.com",
      "enabled": true,
      "default_locale": "en",
      "locales": ["en", "fr"]
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Vous gérez plusieurs centres d'aide ? Consultez la section Créer plusieurs centres d'aide .

Consultez la configuration d'un centre d'aide

La réponse décrit le centre d'aide et tous les paramètres que l'API peut modifier. Relisez-la après une mise à jour des paramètres pour confirmer le nouvel état : les routes de paramètres répondent 204 No Content sans corps.

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
  "full_domain": "help.example.com",
  "enabled": true,
  "default_locale": "en",
  "access_mode": "public",
  "guest_access_requires_login": true,
  "supported_locales": ["en", "fr"],
  "available_locales": ["en", "fr", "de", "es"],
  "auto_sync_enabled": true,
  "seo_indexing_enabled": true,
  "setting_content_items": [
    {"locale": "en", "page_title": "Example Help Center", "page_description": "Answers about Example"}
  ],
  "auto_translate_enabled": false,
  "auto_translate_source_locale": null,
  "llms_txt_enabled": true,
  "markdown_export_enabled": true,
  "ai_contextual_menu_enabled": false,
  "mcp_search_enabled": true,
  "contact_form_enabled": true,
  "changelog_enabled": true,
  "changelog_email_subscriptions_enabled": false,
  "changelog_reactions_enabled": true,
  "changelog_email_subject_pattern": null,
  "changelog_categories": [
    {"category_id": "2984612035", "color": "blue_sky"}
  ]
}

Vérifiez l'état de la synchronisation planifiée

La réponse correspond au même statut que celui affiché par le tableau de bord pour les synchronisations planifiées :

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/sync-status" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "auto_sync_enabled": true,
  "frequency": "daily",
  "next_sync_at": "2026-10-19T06:00:00+00:00",
  "current_status": "idle",
  "recent_runs": [
    {
      "started_at": "2026-10-18T06:00:02+00:00",
      "finished_at": "2026-10-18T06:01:41+00:00",
      "status": "success",
      "message": "Synced successfully.",
      "error_category": null,
      "requires_customer_action": false
    }
  ]
}

Chaque exécution comporte started_at, finished_at (null pendant son exécution, et pour une exécution qui a expiré), status (in_progress, success ou failed), un court message, et pour une exécution ayant échoué :

Lorsque requires_customer_action est remplacé par true, l'exécution suivante échouera également tant que vous n'aurez pas corrigé un problème, comme la connexion à Notion. Consultez la section « Comment synchroniser votre centre d'aide avec Notion » .

L'état de la synchronisation n'affiche que les exécutions planifiées. Une synchronisation déclenchée par l'API ou le tableau de bord n'y figure pas. Consultez la section « Déclencher des synchronisations Notion avec l'API Notiondesk » pour confirmer une synchronisation déclenchée.recent_runs

Erreurs

Chaque route peut également répondre aux requêtes invalid_version, authentication_error, rate_limited et internal_error. Voir Gestion des erreurs, des limites de débit et des nouvelles tentatives de l'API Notiondesk .

Questions fréquentes

Et ensuite ?

• Lisez les articles, les collections et les entrées du journal des modifications avec l'API Notiondesk

• Trigger Notion se synchronise avec l'API Notiondesk

• Mettez à jour les paramètres du centre d'aide avec l'API Notiondesk