Get Bulk Sync

GET

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

GET

/api/bulk/syncs/:id

curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \
     -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"
    }
  }
}

Returns a bulk sync by ID.

The response includes the sync’s top-level configuration — source, destination, schedules, and discovery settings.

To check whether the sync is running and see the most-recent execution result, use GET /api/bulk/syncs/{id}/status.
To inspect which schemas are selected and how they are configured, use GET /api/bulk/syncs/{id}/schemas.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Bulk sync ID

Query parameters

refresh_schemasbooleanOptionalDeprecated

Deprecated; has no effect

Response

dataobjectOptional

The bulk sync

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors