v1
latestOpenAPI 3.0.32026-08-06138294578.6 KBBulk Sync
List Bulk Syncs
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.
get/api/bulk/syncs
Query parameters
activeboolean nullable
Filter to only active (true) or only paused (false) syncs. Omit to return both.
Example:true
Filter to only active (true) or only paused (false) syncs. Omit to return both.
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": "monday",
"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": "monday",
"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"
}
}
]
}