v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB

Bulk Sync

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

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

Path parameters

idstring uuid required

Unique identifier of the bulk sync.

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

Unique identifier of the bulk sync.

Query parameters

page_tokenstring

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

Example:AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K==

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

only_terminalboolean

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

Example:true

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

ascendingboolean

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

Example:true

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

limitinteger

Maximum number of executions to return. Capped at 100.

Example:100

Maximum number of executions to return. Capped at 100.

Headers

X-Polytomic-Versionstring

Response

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {
    "next_page_token": "AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K=="
  }
}