Read your help centers with the Notiondesk API

The Notiondesk API lets you list every help center in your workspace, read each help center's configuration, and check the status of its scheduled Notion sync. Start here: the help center id these routes return is the site_id every other Notiondesk API route takes in its path.

In the Notiondesk API, a help center is called a site.

List your help centers

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

The list includes every help center in the workspace that owns your key, oldest first, using cursor pagination with page_size and cursor.

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

Running several help centers? See Create multiple Help Centers.

Read a help center's configuration

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

The response describes the help center and every setting the API can change. Read it again after a settings update to confirm the new state: the settings routes answer 204 No Content with no body.

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

Check the scheduled sync status

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"

The response is the same status the dashboard shows for scheduled syncs:

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

Each run has started_at, finished_at (null while it runs, and for a run that timed out), status (in_progress, success or failed), a short message, and for a failed run:

When requires_customer_action is true, the next run fails too until you fix something, such as the Notion connection. See How to synchronize your help center with Notion.

The sync status lists scheduled runs only. A sync you trigger through the API or the dashboard does not appear in recent_runs. See Trigger Notion syncs with the Notiondesk API to confirm a triggered sync.

Errors

Every route can also answer invalid_version, authentication_error, rate_limited and internal_error. See Handle Notiondesk API errors, rate limits, and retries.

Common questions

What's next

• Read articles, collections, and changelog entries with the Notiondesk API

• Trigger Notion syncs with the Notiondesk API

• Update help center settings with the Notiondesk API