List Bulk Sync Execution Status

curl https://app.polytomic.com/api/bulk/syncs/status \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "data": [
    {
      "nextExecutionTime": "2024-01-15T09:30:00Z",
      "schemas": [
        {
          "completed_at": "2024-04-25T12:45:00Z",
          "error_count": 2,
          "execution_id": "a3f1c9d2-5b7e-4f8a-9c3d-1e2f4b5a6789",
          "record_count": 1250,
          "schema": "contact",
          "started_at": "2024-04-25T12:00:00Z",
          "status": "running",
          "status_message": "Processing records",
          "warning_count": 1
        },
        {
          "error_count": 0,
          "execution_id": "b7d3e4f5-6a8b-4c9d-8e7f-0a1b2c3d4e5f",
          "record_count": 0,
          "schema": "order",
          "started_at": "2024-04-25T12:30:00Z",
          "status": "scheduled",
          "status_message": "Waiting to start",
          "warning_count": 0
        }
      ],
      "status": "running",
      "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
    },
    {
      "nextExecutionTime": "2024-01-20T14:00:00Z",
      "schemas": [
        {
          "completed_at": "2024-04-24T15:00:00Z",
          "error_count": 0,
          "execution_id": "c9d8e7f6-5a4b-3c2d-1e0f-9a8b7c6d5e4f",
          "record_count": 500,
          "schema": "product",
          "started_at": "2024-04-24T14:00:00Z",
          "status": "completed",
          "status_message": "Execution completed successfully",
          "warning_count": 0
        }
      ],
      "status": "completed",
      "sync_id": "f1e2d3c4-b5a6-7890-1234-56789abcdef0"
    }
  ]
}

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.

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.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

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

datalist of objects or null

Errors

404

Not Found Error

Authentication

Headers

Query parameters

Response

Errors