v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB

Bulk Sync

Get Bulk Sync Status

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}.

get/api/bulk/syncs/{id}/status

Path parameters

idstring uuid required

Unique identifier of the bulk sync.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the bulk sync.

Headers

X-Polytomic-Versionstring

Response

Example response

{
  "data": {
    "current_execution": {
      "completed_at": "2023-04-25T12:00:00Z",
      "created_at": "2023-04-25T12:00:00Z",
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "record_count": 1000,
      "schemas": [
        {
          "completed_at": "2023-04-25T12:00:00Z",
          "created_at": "2023-04-25T12:00:00Z",
          "output_name": "contact",
          "record_count": 1000,
          "schema": "contact",
          "started_at": "2023-04-25T12:00:00Z",
          "updated_at": "2023-04-25T12:00:00Z"
        }
      ],
      "started_at": "2023-04-25T12:00:00Z",
      "type": "scheduled",
      "updated_at": "2023-04-25T12:00:00Z"
    },
    "last_execution": {
      "completed_at": "2023-04-25T12:00:00Z",
      "created_at": "2023-04-25T12:00:00Z",
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "record_count": 1000,
      "schemas": [
        {
          "completed_at": "2023-04-25T12:00:00Z",
          "created_at": "2023-04-25T12:00:00Z",
          "output_name": "contact",
          "record_count": 1000,
          "schema": "contact",
          "started_at": "2023-04-25T12:00:00Z",
          "updated_at": "2023-04-25T12:00:00Z"
        }
      ],
      "started_at": "2023-04-25T12:00:00Z",
      "type": "scheduled",
      "updated_at": "2023-04-25T12:00:00Z"
    },
    "next_execution_time": "2023-04-25T12:00:00Z"
  }
}