List Bulk Syncs

GET

https://app.polytomic.com/api/bulk/syncs

GET

/api/bulk/syncs

curl -G https://app.polytomic.com/api/bulk/syncs \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -u "<username>:<password>" \
     -d active=true

{
  "data": [
    {
      "active": true,
      "automatically_add_new_fields": "all",
      "automatically_add_new_objects": "all",
      "concurrency_limit": 50,
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      },
      "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
      "destination_configuration": {
        "schema": "my_schema"
      },
      "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "disable_record_timestamps": false,
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "mode": "snapshot",
      "name": "My Bulk Sync",
      "normalize_names": "enabled",
      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "policies": [
        "248df4b7-aa70-47b8-a036-33ac447e668d"
      ],
      "resync_concurrency_limit": 10,
      "schedule": {
        "frequency": "manual",
        "day_of_month": "1",
        "day_of_week": "1",
        "hour": "0",
        "minute": "0",
        "month": "1",
        "multi": {
          "schedules": [
            {
              "item": "none",
              "schedule": {
                "frequency": "manual",
                "day_of_month": "1",
                "day_of_week": "1",
                "hour": "0",
                "minute": "0",
                "month": "1"
              }
            }
          ],
          "type": "string"
        }
      },
      "source_configuration": {
        "replication_slot": "slot"
      },
      "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "updated_at": "2024-01-15T09:30:00Z",
      "updated_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      },
      "discover": true
    }
  ]
}

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

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Query parameters

activebooleanOptional

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

Response

datalist of objects or nullOptional

Errors

401

Unauthorized Error

500

Internal Server Error

Authentication

Headers

Query parameters

Response

Errors