Notiondesk API を使用してヘルプセンターをご覧ください。

Notiondesk API を使用すると、ワークスペース内のすべてのヘルプ センターを一覧表示したり、各ヘルプ センターの設定を読み取ったり、スケジュールされた Notion 同期のステータスを確認したりできます。ここから始めます: これらのルートが返すヘルプ センター id は、他のすべての Notiondesk API ルートがパスで受け取る site_id です。

Notiondesk API では、ヘルプ センターはサイトと呼ばれます。

ヘルプセンターの一覧を表示してください

このリストには、ワークスペース内であなたのキーを所有するすべてのヘルプセンターが、古い順に表示されます。カーソルによるページネーションは、page_size と 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
}

複数のヘルプセンターを運営していますか？ 「複数のヘルプセンターを作成する」を参照してください。

ヘルプセンターの設定を読む

このレスポンスには、ヘルプセンターとAPIで変更可能なすべての設定が記載されています。設定を更新した後、再度このレスポンスを読んで新しい状態を確認してください。設定ルートは、本文なしで204 No Contentというレスポンスを返します。

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

スケジュールされた同期ステータスを確認してください

応答は、スケジュールされた同期についてダッシュボードに表示されるステータスと同じです。

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

各実行には、started_at、finished_at（実行中はnull、タイムアウトした場合はstatus（in_progress、successまたはfailed）、短いmessage、および失敗した実行があります。

requires_customer_action が true の場合、Notion との接続などの問題を修正するまで、次の実行も失敗します。 ヘルプセンターを Notion と同期する方法を参照してください。

同期ステータスには、スケジュールされた実行のみが表示されます。API またはダッシュボードからトリガーした同期は表示されません。トリガーされた同期を確認するには、 「トリガー Notion 同期を Notiondesk API と同期する」を参照してください。recent_runs

エラー

すべてのルートは、invalid_version、authentication_error、rate_limited、およびinternal_errorにも応答できます。__ ND_TERM_5bcd8dee__ APIエラー、レート制限、および再試行の処理を参照してください。

よくある質問

次は？

• Notiondesk API を使用して、記事、コレクション、変更履歴エントリを読み取ります。

• Trigger NotionはNotiondesk APIと同期します

• Notiondesk API を使用してヘルプセンターの設定を更新します