Lesen Sie Ihre Hilfezentren mit der Notiondesk API.

Die Notiondesk-API ermöglicht es Ihnen, alle Hilfezentren in Ihrem Workspace aufzulisten, die Konfiguration jedes Hilfezentrums einzusehen und den Status der geplanten Notion-Synchronisierung zu überprüfen. Beginnen Sie hier: Das Hilfezentrum id, das diese Routen zurückgeben, ist das site_id, das jede andere Notiondesk-API-Route in ihrem Pfad verwendet.

In der Notiondesk API wird ein Hilfezentrum als Site bezeichnet.

Listen Sie Ihre Hilfezentren auf

Die Liste enthält alle Hilfezentren im Arbeitsbereich, die Ihren Schlüssel besitzen, beginnend mit dem ältesten, unter Verwendung der Cursor-Paginierung mit page_size und 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
}

Sie betreiben mehrere Hilfezentren? Dann lesen Sie den Artikel „Mehrere Hilfezentren erstellen“ .

Lesen Sie die Konfiguration eines Hilfezentrums.

Die Antwort beschreibt das Hilfecenter und alle Einstellungen, die über die API geändert werden können. Lesen Sie sie nach einer Aktualisierung der Einstellungen erneut, um den neuen Status zu bestätigen: Die Einstellungsrouten antworten mit 204 No Content ohne Inhalt.

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

Überprüfen Sie den geplanten Synchronisierungsstatus

Die Antwort entspricht dem Status, den das Dashboard für geplante Synchronisierungen anzeigt:

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

Jeder Lauf enthält started_at, finished_at (null während der Laufzeit und für einen Lauf, der ein Timeout verursacht hat), status (in_progress, success oder failed), ein kurzes message und für einen fehlgeschlagenen Lauf:

Wenn requires_customer_action den Wert true hat, schlägt auch der nächste Durchlauf fehl, bis Sie ein Problem beheben, beispielsweise die Notion-Verbindung. Weitere Informationen finden Sie unter „So synchronisieren Sie Ihr Hilfezentrum mit Notion“ .

Der Synchronisierungsstatus zeigt nur geplante Ausführungen an. Eine Synchronisierung, die Sie über die API oder das Dashboard auslösen, wird hier nicht angezeigt. Informationen zur Bestätigung einer ausgelösten Synchronisierung finden Sie unter „Notion-Synchronisierungen mit der Notiondesk-API auslösen“ .recent_runs

Fehler

Jede Route kann auch invalid_version, authentication_error, rate_limited und internal_error beantworten. Siehe „Behandlung von Notiondesk-API-Fehlern, Ratenbegrenzungen und Wiederholungsversuchen“ .

Häufig gestellte Fragen

Was kommt als Nächstes?

• Lesen Sie Artikel, Sammlungen und Änderungsprotokolleinträge mit der Notiondesk API.

• Trigger Notion synchronisiert sich mit der Notiondesk API

• Aktualisieren Sie die Einstellungen des Hilfecenters mit der Notiondesk API