Sync

Get a site's sync status

Reads a site's scheduled sync: whether it is on, how often it runs, its next run and its recent runs.

GET
/sites/{site_id}/sync-status
cURL
curl --request GET \
  --url 'https://api.notiondesk.so/sites/{site_id}/sync-status' \
  --header 'Authorization: Bearer <token>'

Ủy quyền

  • Authorizationstringheader

    api_key · http · bearer

    read
  • Authorizationstringheader

    oauth · oauth2

    read

Tham số đường dẫn

  • site_idstringbắt buộc

    The id of a site from List sites.

Tiêu đề

  • nd-versionstring

    The contract version your integration was written against. Without it, the request uses the current version. An unknown value answers 400 invalid_version.

Phản hồi

The sync status.

Tiêu đề

  • nd-versionstring

    The contract version that answered the request.

  • X-RateLimit-Limitinteger

    Requests allowed per minute: 120 for GET, 20 for writes, per key or OAuth grant.

  • X-RateLimit-Remaininginteger

    Requests left in the current window.

  • Retry-Afterinteger

    Seconds until the next request is accepted; 0 while requests remain.

  • auto_sync_enabledbooleanbắt buộc

    Whether the site syncs from its source on a schedule.

  • frequencystring | nullbắt buộc

    How often the scheduled sync runs; null when scheduled sync is off.

  • next_sync_atstring | nullbắt buộc

    When the next scheduled sync starts; null when scheduled sync is off or none is planned.

  • current_statusstringbắt buộc

    in_progress while a scheduled run is going, failed when the latest run failed, otherwise idle.

  • recent_runsobject[]bắt buộc

    Up to the 10 most recent scheduled runs, newest first.

    • started_atstring | nullbắt buộc

      When the run started.

    • finished_atstring | nullbắt buộc

      When the run ended; null while it runs.

    • statusstringbắt buộc
    • messagestringbắt buộc

      A short description of the outcome.

    • error_categorystring | nullbắt buộc

      The cause of a failed run.

    • requires_customer_actionbooleanbắt buộc

      Whether the failure needs you to fix something, for example a Notion connection, before the next run can succeed.