POpolytomic
Bulk Sync

List Bulk Sync Execution Status

Changed on

Returns a concise per-schema status for one or more bulk syncs.

This endpoint is a summary view, not an execution-history view. Each schema is represented at most once with its most recent execution status, and running executions are preferred over older terminal ones.

Use this endpoint when you want a dashboard-style answer to "what is each sync doing now?" If you need the full execution history or a single execution's details, use GET /api/bulk/syncs/{id}/executions or GET /api/bulk/syncs/{id}/executions/{exec_id} instead.

Setting all=true or active=true ignores any explicit sync_id filters and expands the request to the caller's organization scope.

get/api/bulk/syncs/status

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Query parameters

allboolean

When true, return status for every sync in the caller's organization. Overrides any sync_id values.

Example:true
activeboolean

When true, return status only for active syncs in the caller's organization. Overrides any sync_id values.

Example:true
sync_idstring[]

Return status for the specified bulk sync. Repeat the parameter to target multiple syncs. Ignored if all or active is true.

[
  "248df4b7-aa70-47b8-a036-33ac447e668d"
]

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": [
    {
      "schemas": [
        {
          "completed_at": "2023-04-25T12:00:00Z",
          "execution_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
          "record_count": 1000,
          "schema": "contact",
          "started_at": "2023-04-25T12:00:00Z"
        }
      ],
      "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
    }
  ]
}

Changes

  • 61c2b96f65baRevision changes
    • breaking

      the //// response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the //// response property allOf list for the response status

    • info

      removed the canceled enum value from the //// response property for the response status

    • info

      removed the canceled enum value from the // response property for the response status

    • info

      removed the canceling enum value from the // response property for the response status

    • info

      removed the completed enum value from the //// response property for the response status

    • info

      removed the completed enum value from the // response property for the response status

    • info

      removed the completed_with_cancellations enum value from the // response property for the response status

    • info

      removed the created enum value from the //// response property for the response status

    • info

      removed the created enum value from the // response property for the response status

    • info

      removed the errors enum value from the // response property for the response status

    • info

      removed the exporting enum value from the //// response property for the response status

    • info

      removed the exporting enum value from the // response property for the response status

    • info

      removed the failed enum value from the //// response property for the response status

    • info

      removed the failed enum value from the // response property for the response status

    • info

      removed the interrupted enum value from the //// response property for the response status

    • info

      removed the interrupted enum value from the // response property for the response status

    • info

      removed the processing enum value from the //// response property for the response status

    • info

      removed the processing enum value from the // response property for the response status

    • info

      removed the running enum value from the //// response property for the response status

    • info

      removed the running enum value from the // response property for the response status

    • info

      removed the scheduled enum value from the //// response property for the response status

    • info

      removed the scheduled enum value from the // response property for the response status

  • a4c3b8f8eff7Revision changes
    • warning

      added the new completed_with_cancellations enum value to the // response property for the response status