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
Logo
Log inBook a demo
API ReferenceBulk Sync

Get Bulk Sync Status

GET
https://app.polytomic.com/api/bulk/syncs/:id/status
GET
/api/bulk/syncs/:id/status
$curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status \
>     -H "X-Polytomic-Version: X-Polytomic-Version" \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>"
1{
2  "data": {
3    "current_execution": {
4      "completed_at": "2024-04-20T15:45:00Z",
5      "created_at": "2024-04-20T14:00:00Z",
6      "error_count": 2,
7      "fetch_mode": "incremental",
8      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
9      "is_partial": false,
10      "is_resync": true,
11      "is_test": false,
12      "output_disposition": "truncate",
13      "record_count": 1250,
14      "schemas": [
15        {
16          "completed_at": "2024-04-20T15:30:00Z",
17          "created_at": "2024-04-20T14:05:00Z",
18          "error_count": 1,
19          "output_name": "account",
20          "record_count": 800,
21          "schema": "account",
22          "started_at": "2024-04-20T14:10:00Z",
23          "status": "running",
24          "status_message": "Processing account records",
25          "updated_at": "2024-04-20T15:25:00Z",
26          "warning_count": 3
27        },
28        {
29          "completed_at": null,
30          "created_at": "2024-04-20T14:05:00Z",
31          "error_count": 1,
32          "output_name": "contact",
33          "record_count": 450,
34          "schema": "contact",
35          "started_at": "2024-04-20T14:15:00Z",
36          "status": "running",
37          "status_message": "Fetching contact data",
38          "updated_at": "2024-04-20T15:40:00Z",
39          "warning_count": 0
40        }
41      ],
42      "started_at": "2024-04-20T14:00:00Z",
43      "status": "running",
44      "status_message": "Bulk sync is currently running",
45      "type": "scheduled",
46      "updated_at": "2024-04-20T15:45:00Z",
47      "warning_count": 3
48    },
49    "ingestion_status": {
50      "enabled": true,
51      "highwater_mark": "2024-04-20T15:00:00Z",
52      "is_running": true,
53      "position": "offset_12345",
54      "position_time": "2024-04-20T15:30:00Z",
55      "status": "ok",
56      "status_message": "CDC ingestion operating normally",
57      "updated_at": "2024-04-20T15:45:00Z"
58    },
59    "last_execution": {
60      "completed_at": "2024-04-19T12:00:00Z",
61      "created_at": "2024-04-19T10:00:00Z",
62      "error_count": 0,
63      "fetch_mode": "incremental",
64      "id": "a3f9c1d2-5b6e-4f7a-9c3d-1e2f3a4b5c6d",
65      "is_partial": false,
66      "is_resync": false,
67      "is_test": false,
68      "output_disposition": "retain",
69      "record_count": 1200,
70      "schemas": [
71        {
72          "completed_at": "2024-04-19T11:45:00Z",
73          "created_at": "2024-04-19T10:05:00Z",
74          "error_count": 0,
75          "output_name": "contact",
76          "record_count": 1200,
77          "schema": "contact",
78          "started_at": "2024-04-19T10:10:00Z",
79          "status": "completed",
80          "status_message": "Completed successfully",
81          "updated_at": "2024-04-19T11:50:00Z",
82          "warning_count": 0
83        }
84      ],
85      "started_at": "2024-04-19T10:00:00Z",
86      "status": "completed",
87      "status_message": "Last sync completed without errors",
88      "type": "scheduled",
89      "updated_at": "2024-04-19T12:00:00Z",
90      "warning_count": 0
91    },
92    "next_execution_time": "2024-04-21T14:00:00Z"
93  }
94}
Returns the current status of a bulk sync. The response includes the sync's current active/inactive state together with information about the most recent execution — its status, start time, and any errors — making this endpoint well-suited for health checks and monitoring dashboards. For the complete execution history, use [`GET /api/bulk/syncs/{id}/executions`](../../../../../api-reference/bulk-sync/executions/list). For the full details of a specific run, including per-schema breakdowns, use [`GET /api/bulk/syncs/{id}/executions/{exec_id}`](../../../../../api-reference/bulk-sync/executions/get).
Was this page helpful?
Previous

Get Bulk Source

Next

Returns the current status of a bulk sync.

The response includes the sync’s current active/inactive state together with information about the most recent execution — its status, start time, and any errors — making this endpoint well-suited for health checks and monitoring dashboards.

For the complete execution history, use GET /api/bulk/syncs/{id}/executions. For the full details of a specific run, including per-schema breakdowns, use GET /api/bulk/syncs/{id}/executions/{exec_id}.

Authentication

AuthorizationBasic

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

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the bulk sync.

Headers

X-Polytomic-VersionstringRequired

Response

OK
dataobject

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error