List Bulk Syncs

GET

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

GET

/api/bulk/syncs

curl https://app.polytomic.com/api/bulk/syncs \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "active": true,
      "additional_schedules": [
        {
          "frequency": "weekly",
          "created_at": "2023-04-25T12:00:00Z",
          "created_by": {
            "id": "12345678-1234-1234-1234-123456789012",
            "name": "John Doe",
            "type": "user"
          },
          "day_of_week": "monday",
          "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"
          }
        },
        {
          "frequency": "continuous",
          "created_at": "2023-04-25T12:00:00Z",
          "created_by": {
            "id": "12345678-1234-1234-1234-123456789012",
            "name": "John Doe",
            "type": "user"
          },
          "selective_mode": "incrementalFields",
          "updated_at": "2023-04-25T12:00:00Z",
          "updated_by": {
            "id": "12345678-1234-1234-1234-123456789012",
            "name": "John Doe",
            "type": "user"
          }
        }
      ],
      "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",
      "default_schedule": {
        "frequency": "manual",
        "created_at": "2024-01-15T09:30:00Z",
        "created_by": {
          "id": "12345678-1234-1234-1234-123456789012",
          "name": "John Doe",
          "type": "user"
        },
        "day_of_month": "1",
        "day_of_week": "monday",
        "hour": "12",
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "minute": "30",
        "month": "1",
        "updated_at": "2024-01-15T09:30:00Z",
        "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",
      "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,
      "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"
      }
    }
  ]
}

Lists bulk syncs in the caller’s organization.

Results are ordered by updated_at descending, with id as a tiebreaker for syncs modified at the same instant. Pagination uses an opaque pagination.next_page_token returned in the response; pass it back as the page_token query parameter to fetch the next page. The limit parameter is optional, and the default and maximum page size is 50 syncs.

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

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped 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

Bulk syncs matching the filters

Errors

500

Internal Server Error

Authentication

Headers

Query parameters

Response

Errors