List Bulk Sync Executions | Polytomic Docs

curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "completed_at": "2023-04-25T12:00:00Z",
      "created_at": "2023-04-25T12:00:00Z",
      "error_count": 0,
      "fetch_mode": "none",
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "is_partial": false,
      "is_resync": false,
      "is_test": false,
      "output_disposition": "retain",
      "record_count": 1000,
      "schemas": [
        {
          "completed_at": "2023-04-25T12:00:00Z",
          "created_at": "2023-04-25T12:00:00Z",
          "error_count": 0,
          "output_name": "contact",
          "record_count": 1000,
          "schema": "contact",
          "started_at": "2023-04-25T12:00:00Z",
          "status": "created",
          "status_message": "string",
          "updated_at": "2023-04-25T12:00:00Z",
          "warning_count": 0
        }
      ],
      "started_at": "2023-04-25T12:00:00Z",
      "status": "created",
      "status_message": "string",
      "type": "scheduled",
      "updated_at": "2023-04-25T12:00:00Z",
      "warning_count": 0
    }
  ],
  "pagination": {
    "next_page_token": "AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K=="
  }
}

Lists executions for a bulk sync.

Results are ordered by start time descending by default. When more results are available, the response includes an opaque pagination.next_page_token; pass it back as the page_token query parameter to retrieve the next page. The limit parameter is optional, and the maximum page size is 100 executions.

Use only_terminal=true to return only finished executions. In that mode, executions are ordered by updated_at so recently completed runs appear first.

Use ascending=true to walk forward from the oldest execution instead of starting with the newest execution.

For the full details of a single run — including per-schema execution status — use GET /api/bulk/syncs/{id}/executions/{exec_id}.

Lists executions for a bulk sync. Results are ordered by start time descending by default. When more results are available, the response includes an opaque `pagination.next_page_token`; pass it back as the `page_token` query parameter to retrieve the next page. The `limit` parameter is optional, and the maximum page size is 100 executions. Use `only_terminal=true` to return only finished executions. In that mode, executions are ordered by `updated_at` so recently completed runs appear first. Use `ascending=true` to walk forward from the oldest execution instead of starting with the newest execution. For the full details of a single run — including per-schema execution status — use [`GET /api/bulk/syncs/{id}/executions/{exec_id}`](../../../../../api-reference/bulk-sync/executions/get).

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the bulk sync.

Query parameters

page_tokenstringOptional

Pagination cursor returned in the previous response. Omit on the first request.

only_terminalbooleanOptional

When true, only return executions that have finished. Terminal executions are ordered by updated_at.

ascendingbooleanOptional

When true, return executions from oldest to newest. Default is newest first.

limitintegerOptional

Maximum number of executions to return. Capped at 100.

Response

datalist of objects or null

paginationobject

Errors

404

Not Found Error