For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETList Bulk Syncs
      • POSTCreate Bulk Sync
      • GETGet Bulk Sync
      • PUTUpdate Bulk Sync
      • DELDelete Bulk Sync
      • POSTActivate Bulk Sync
      • POSTCancel Bulk Sync
      • POSTStart Bulk Sync Execution
      • GETGet Bulk Sync Status
      • GETGet Bulk Source
      • GETGet Bulk Destination
        • GETList Bulk Sync Execution Status
        • GETList Bulk Sync Executions
        • GETGet Bulk Sync Execution
        • POSTCancel Bulk Sync Execution
        • GETGet Bulk Sync Execution Logs
        • POSTExport Sync Logs
Logo
Log inBook a demo
API ReferenceBulk SyncExecutions

List Bulk Sync Execution Status

GET
https://app.polytomic.com/api/bulk/syncs/status
GET
/api/bulk/syncs/status
$curl https://app.polytomic.com/api/bulk/syncs/status \
>     -H "X-Polytomic-Version: X-Polytomic-Version" \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>"
1{
2  "data": [
3    {
4      "nextExecutionTime": "2024-01-15T09:30:00Z",
5      "schemas": [
6        {
7          "completed_at": "2023-12-10T14:45:00Z",
8          "error_count": 2,
9          "execution_id": "a3f1c9d2-5b7e-4f8a-9d3c-1e2b4f6a7c8d",
10          "record_count": 1520,
11          "schema": "contact",
12          "started_at": "2023-12-10T14:00:00Z",
13          "status": "running",
14          "status_message": "Processing records",
15          "warning_count": 1
16        }
17      ],
18      "status": "running",
19      "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
20    }
21  ]
22}
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`](../../../../api-reference/bulk-sync/executions/list) or [`GET /api/bulk/syncs/{id}/executions/{exec_id}`](../../../../api-reference/bulk-sync/executions/get) instead. Setting `all=true` or `active=true` ignores any explicit `sync_id` filters and expands the request to the caller's organization scope.
Was this page helpful?
Previous

List Bulk Sync Executions

Next

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.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Headers

X-Polytomic-VersionstringRequired

Query parameters

allbooleanOptional

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

activebooleanOptional

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

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

Response

OK
datalist of objects or null

Errors

401
Unauthorized Error
404
Not Found Error