API ReferenceBulk SyncSchemas

Get Bulk Sync Schemas

Lists the schemas configured on 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

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Polytomic-VersionstringRequired

Query parameters

filtersmap from strings to stringsOptional

Response

OK
datalist of objects or null

Errors

401
Unauthorized Error
404
Not Found Error