Bulk Sync

List Bulk Sync Executions

Changed on

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

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

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

Unique identifier of the bulk sync

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

Query parameters

page_tokenstring

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

Example:AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K==
only_terminalboolean

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

Example:true
ascendingboolean

Traverse from the oldest executions by the selected sort timestamp; each page is ordered newest first.

Example:true
limitinteger

Maximum number of executions to return. Capped at 100.

Example:100

Headers

X-Polytomic-Versionstring

Response

OK

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",
          "version": "rel2026.08.05.06~1a2b3c4"
        }
      ],
      "started_at": "2023-04-25T12:00:00Z",
      "type": "scheduled",
      "updated_at": "2023-04-25T12:00:00Z",
      "version": "rel2026.08.05.06~1a2b3c4"
    }
  ],
  "pagination": {
    "next_page_token": "AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K=="
  }
}

Changes

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the //// response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the //// response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed the canceled enum value from the //// response property for the response status

    • info

      removed the canceled enum value from the // response property for the response status

    • info

      removed the canceling enum value from the // response property for the response status

    • info

      removed the completed enum value from the //// response property for the response status

    • info

      removed the completed enum value from the // response property for the response status

    • info

      removed the completed_with_cancellations enum value from the // response property for the response status

    • info

      removed the created enum value from the //// response property for the response status

    • info

      removed the created enum value from the // response property for the response status

    • info

      removed the errors enum value from the // response property for the response status

    • info

      removed the exporting enum value from the //// response property for the response status

    • info

      removed the exporting enum value from the // response property for the response status

    • info

      removed the failed enum value from the //// response property for the response status

    • info

      removed the failed enum value from the // response property for the response status

    • info

      removed the full enum value from the // response property for the response status

    • info

      removed the incremental enum value from the // response property for the response status

    • info

      removed the interrupted enum value from the //// response property for the response status

    • info

      removed the interrupted enum value from the // response property for the response status

    • info

      removed the none enum value from the // response property for the response status

    • info

      removed the processing enum value from the //// response property for the response status

    • info

      removed the processing enum value from the // response property for the response status

    • info

      removed the rebuild enum value from the // response property for the response status

    • info

      removed the retain enum value from the // response property for the response status

    • info

      removed the running enum value from the //// response property for the response status

    • info

      removed the running enum value from the // response property for the response status

    • info

      removed the scheduled enum value from the //// response property for the response status

    • info

      removed the scheduled enum value from the // response property for the response status

    • info

      removed the truncate enum value from the // response property for the response status

    • warning

      added the new completed_with_cancellations enum value to the // response property for the response status