Skip to navigation
API ReferenceBulk SyncExecutions

List Bulk Sync Executions

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

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the bulk sync

Headers

X-Polytomic-VersionstringOptional

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

OK
datalist of objects or nullOptional
Executions on this page
paginationobjectOptional
Pagination details for the next page

Errors

404
Not Found Error