Skip to navigation

Get Bulk Source

Lists the schemas (tables or objects) available on a connection for use as a bulk sync source, optionally including per-schema field details.

The response reflects what the connection currently has cached; if the upstream source has changed, trigger a refresh first with POST /api/connections/{id}/schemas/refresh.

These are the schemas available for selection, not the schemas already configured on any particular sync. To inspect schemas on a running sync, use GET /api/bulk/syncs/{id}/schemas.

Pass include_fields=true to receive per-schema field details in a single call. Omit it when you only need the schema list, as field enumeration can be slow for large sources.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the connection

Headers

X-Polytomic-VersionstringOptional

Query parameters

include_fieldsbooleanOptionalDefaults to true

When true, include per-schema field lists in the response. Set to false for a smaller payload when field details are not needed.

Response

OK
dataobjectOptional
Bulk sync source details for the connection

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error