Đọc các trung tâm trợ giúp của bạn với API Notiondesk

API Notiondesk cho phép bạn liệt kê mọi trung tâm trợ giúp trong không gian làm việc của mình, đọc cấu hình của từng trung tâm trợ giúp và kiểm tra trạng thái đồng bộ hóa Notion theo lịch trình của nó. Bắt đầu từ đây: trung tâm trợ giúp id mà các tuyến đường này trả về chính là site_id mà mọi tuyến đường API Notiondesk khác đều nhận trong đường dẫn của nó.

Trong API Notiondesk, trung tâm trợ giúp được gọi là một trang web .

Liệt kê các trung tâm trợ giúp của bạn

Danh sách này bao gồm mọi trung tâm trợ giúp trong không gian làm việc sở hữu khóa của bạn, được sắp xếp theo thứ tự cũ nhất trước, sử dụng phân trang con trỏ với page_size và 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
}

Bạn đang quản lý nhiều trung tâm trợ giúp? Xem phần Tạo nhiều Trung tâm trợ giúp .

Đọc cấu hình của trung tâm trợ giúp

Phản hồi mô tả trung tâm trợ giúp và mọi cài đặt mà API có thể thay đổi. Hãy đọc lại sau khi cập nhật cài đặt để xác nhận trạng thái mới: các tuyến cài đặt trả về 204 No Content mà không có nội dung.

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

Kiểm tra trạng thái đồng bộ theo lịch trình

Phản hồi nhận được có cùng trạng thái như trên bảng điều khiển đối với các lần đồng bộ theo lịch trình:

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

Mỗi lần chạy đều có started_at, finished_at (null trong khi chạy và đối với lần chạy bị hết thời gian), status (in_progress, success hoặc failed), một message ngắn, và đối với lần chạy thất bại:

Khi requires_customer_action là true, lần chạy tiếp theo cũng sẽ thất bại cho đến khi bạn khắc phục được sự cố, chẳng hạn như kết nối Notion. Xem Cách đồng bộ hóa trung tâm trợ giúp của bạn với Notion .

Trạng thái đồng bộ chỉ hiển thị các lần chạy theo lịch trình. Một lần đồng bộ bạn kích hoạt thông qua API hoặc bảng điều khiển sẽ không xuất hiện trong danh sách này. Xem phần Kích hoạt đồng bộ Notion bằng API Notiondesk để xác nhận lần đồng bộ đã được kích hoạt.recent_runs

Lỗi

Mỗi tuyến đường cũng có thể trả lời invalid_version, authentication_error, rate_limited và internal_error. Xem Xử lý lỗi API Notiondesk, giới hạn tỷ lệ và số lần thử lại .

Câu hỏi thường gặp

Tiếp theo là gì?

• Đọc các bài viết, bộ sưu tập và mục nhật ký thay đổi bằng API Notiondesk

• Trigger Notion đồng bộ với API Notiondesk

• Cập nhật cài đặt trung tâm trợ giúp bằng API Notiondesk