v1
latestOpenAPI 3.0.32026-08-06138294578.6 KBList Bulk Sync Execution Status
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.
Query parameters
When true, return status for every sync in the caller's organization. Overrides any sync_id values.
When true, return status for every sync in the caller's organization. Overrides any sync_id values.
When true, return status only for active syncs in the caller's organization. Overrides any sync_id values.
When true, return status only for active syncs in the caller's organization. Overrides any sync_id values.
Return status for the specified bulk sync. Repeat the parameter to target multiple syncs. Ignored if all or active is true.
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
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"
}
]
}