List Bulk Syncs | Polytomic Docs

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

{
  "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": "monday",
        "hour": "0",
        "minute": "0",
        "month": "1",
        "multi": {
          "schedules": [
            {
              "item": "none"
            }
          ],
          "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. This version of the endpoint supports the active filter but does not support cursor pagination, limit, or page_token query parameters.

If you need a cursor-paginated bulk sync list, use API version 2025-09-18 or later.

📘 To retrieve a specific sync, use GET /api/bulk/syncs/{id} instead of filtering the list client-side.

Lists bulk syncs in the caller's organization. Results are returned as a single `data` array. This version of the endpoint supports the `active` filter but does not support cursor pagination, `limit`, or `page_token` query parameters. If you need a cursor-paginated bulk sync list, use API version `2025-09-18` or later. > 📘 To retrieve a specific sync, use > [`GET /api/bulk/syncs/{id}`](../../../api-reference/bulk-sync/get) > instead of filtering the list client-side.

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 null

Errors

401

Unauthorized Error

500

Internal Server Error

Authentication

Headers

Query parameters

Response

Errors