Skip to navigation
API ReferenceBulk SyncExecutions

List Bulk Sync Executions

Lists executions for a bulk sync.

Results are ordered by created_at descending by default. Pass the opaque pagination.next_page_token back as page_token to retrieve the next page. A token is returned even on the last nonempty page and on subsequent empty pages. Stop paging when data is empty; the presence of a token does not mean more results are available. The maximum page size is 100 executions.

Use only_terminal=true to return only executions in terminal statuses. In that mode, ordering and pagination use updated_at instead of created_at.

Use ascending=true to walk forward from the oldest executions by the selected sort timestamp. Each page still lists its executions newest first; subsequent pages contain newer executions.

For the full details of a single run, including per-schema execution status, 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

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

Traverse from the oldest executions by the selected sort timestamp; each page is ordered 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

401
Unauthorized Error
404
Not Found Error