API ReferenceBulk SyncSchemas

Get Bulk Sync Schemas

Lists the schemas (tables, objects) configured for a bulk sync. This endpoint returns the schemas that have been added to and configured on this specific bulk sync — not the full set of schemas available from the source connection. To discover what the source connection exposes, use the source schemas endpoint for the relevant connection type. Each schema in the response includes its sync mode, field selections, and any custom configuration applied via [`PATCH /api/bulk/syncs/{id}/schemas`](../../../../../api-reference/bulk-sync/schemas/patch) or [`PUT /api/bulk/syncs/{id}/schemas/{schema_id}`](../../../../../api-reference/bulk-sync/schemas/update).

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the bulk sync.

Headers

X-Polytomic-VersionstringOptional

Query parameters

filtersmap from strings to stringsOptional

Optional filters applied to the returned schemas. Supports enabled=true to return only enabled schemas and enabled=false to return only disabled schemas.

Response

OK
datalist of objects or null

Errors

404
Not Found Error