Lees de helpcentra met de Notiondesk API

Met de Notiondesk API kunt u alle helpcentra in uw werkruimte weergeven, de configuratie van elk helpcentrum lezen en de status van de geplande Notion-synchronisatie controleren. Begin hier: het helpcentrum id dat deze routes retourneren, is het site_id dat elke andere Notiondesk API-route in zijn pad opneemt.

In de Notiondesk API wordt een helpcentrum een ​​site genoemd.

Geef een overzicht van uw helpcentra.

De lijst bevat alle helpcentra in de werkruimte die eigenaar zijn van uw sleutel, gesorteerd van oudst naar gelang, met behulp van cursorpaginering met page_size en 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
}

Beheert u meerdere helpcentra? Zie Meerdere helpcentra maken .

Lees de configuratie van een helpcentrum

Het antwoord beschrijft het helpcentrum en alle instellingen die de API kan wijzigen. Lees het na een update van de instellingen nogmaals door om de nieuwe status te bevestigen: de instellingenroutes antwoorden 204 No Content zonder inhoud.

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

Controleer de status van de geplande synchronisatie.

Het antwoord is dezelfde status die het dashboard weergeeft voor geplande synchronisaties:

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

Elke run heeft started_at, finished_at (null tijdens de uitvoering en voor een run die een time-out heeft bereikt), status (in_progress, success of failed), een korte message, en voor een mislukte run:

Als requires_customer_action true is, mislukt de volgende keer dat het programma wordt uitgevoerd ook, totdat je iets hebt gecorrigeerd, zoals de Notion-verbinding. Zie Hoe synchroniseer je je helpcentrum met Notion ?

De synchronisatiestatus toont alleen geplande synchronisaties. Een synchronisatie die u via de API of het dashboard start, wordt hier niet weergegeven. Zie Notion-synchronisaties starten met de Notiondesk API om te bevestigen of een synchronisatie is gestart.recent_runs

Fouten

Elke route kan ook antwoorden op invalid_version, authentication_error, rate_limited en internal_error. Zie API-fouten, snelheidslimieten en herhaalpogingen voor Notiondesk afhandelen .

Veelgestelde vragen

Wat volgt?

• Lees artikelen, collecties en wijzigingslogboeken met de Notiondesk API

• Trigger Notion synchroniseert met de Notiondesk API

• Update de instellingen van het helpcentrum met de Notiondesk API