Bulk Sync

Lists bulk syncs in the caller's organization.

Results are returned as a single data array. You can filter by active, but this endpoint does not support pagination, limit, or page_token query parameters.

To retrieve a specific Bulk Sync, use GET /api/bulk/syncs/{id}.

get/api/bulk/syncs

Request

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

Query parameters

activeboolean nullable

Filter to only active (true) or only paused (false) syncs. Omit to return both.

Example:true

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": [
    {
      "active": true,
      "additional_schedules": [
        {
          "created_at": "2023-04-25T12:00:00Z",
          "created_by": {
            "id": "12345678-1234-1234-1234-123456789012",
            "name": "John Doe",
            "type": "user"
          },
          "day_of_week": "1",
          "frequency": "weekly",
          "hour": "12",
          "minute": "30",
          "selective_mode": "nonincrementalFields",
          "updated_at": "2023-04-25T12:00:00Z",
          "updated_by": {
            "id": "12345678-1234-1234-1234-123456789012",
            "name": "John Doe",
            "type": "user"
          }
        },
        {
          "created_at": "2023-04-25T12:00:00Z",
          "created_by": {
            "id": "12345678-1234-1234-1234-123456789012",
            "name": "John Doe",
            "type": "user"
          },
          "frequency": "continuous",
          "selective_mode": "incrementalFields",
          "updated_at": "2023-04-25T12:00:00Z",
          "updated_by": {
            "id": "12345678-1234-1234-1234-123456789012",
            "name": "John Doe",
            "type": "user"
          }
        }
      ],
      "concurrency_limit": 50,
      "created_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      },
      "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
      "default_schedule": {
        "created_by": {
          "id": "12345678-1234-1234-1234-123456789012",
          "name": "John Doe",
          "type": "user"
        },
        "day_of_month": "1",
        "day_of_week": "1",
        "hour": "12",
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "minute": "30",
        "month": "1",
        "updated_by": {
          "id": "12345678-1234-1234-1234-123456789012",
          "name": "John Doe",
          "type": "user"
        }
      },
      "destination_configuration": {
        "schema": "my_schema"
      },
      "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "name": "My Bulk Sync",
      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "policies": [
        "248df4b7-aa70-47b8-a036-33ac447e668d"
      ],
      "resync_concurrency_limit": 10,
      "source_configuration": {
        "replication_slot": "slot"
      },
      "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "updated_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      }
    }
  ]
}

Changes

    • breaking

      the //// response's property type changed from object 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

    • 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

    • breaking

      the // response's property type changed from object 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

    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the 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

      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

      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 all enum value from the // response property for the response status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      removed the multi 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 none 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 nonincrementalFields enum value from the //// response property for the response status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      removed the onlyNonIncremental 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 refetch enum value from the //// response property for the response status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • warning

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