קרא את מרכזי העזרה שלך עם ממשק ה-API Notiondesk

ממשק ה-API Notiondesk מאפשר לך לרשום כל מרכז עזרה בסביבת העבודה שלך, לקרוא את התצורה של כל מרכז עזרה ולבדוק את מצב הסנכרון המתוזמן של Notion. התחל כאן: מרכז העזרה id שהנתיבים האלה מחזירים הוא ה-site_id שכל נתיב API Notiondesk אחר עובר בנתיב שלו.

בממשק ה-API Notiondesk, מרכז עזרה נקרא אתר .

רשום את מרכזי העזרה שלך

הרשימה כוללת כל מרכז עזרה בסביבת העבודה שבבעלותו המפתח שלך, הישן ביותר תחילה, באמצעות עימוד סמן עם 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 או לוח המחוונים אינו מופיע ב-. ראה Trigger Notion מסנכרן עם ה-API Notiondesk כדי לאשר סנכרון שהופעל.recent_runs

שגיאות

כל מסלול יכול גם לענות על invalid_version, authentication_error, rate_limited ו-internal_error. ראה טיפול בשגיאות API, מגבלות קצב וניסיונות חוזרים של Notiondesk .

שאלות נפוצות

מה הלאה

• קרא מאמרים, אוספים ורשומות ביומן שינויים בעזרת ממשק ה-API Notiondesk

• Trigger Notion מסתנכרן עם ממשק ה-API Notiondesk

• עדכון הגדרות מרכז העזרה באמצעות ממשק ה-API Notiondesk