Get Bulk Source
Changed onLists 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.
Request
- Base URLhttps://app.polytomic.com
- Auth
- HTTP bearer
- or HTTP basic
Path parameters
Unique identifier of the connection
Query parameters
When true, include per-schema field lists in the response. Set to false for a smaller payload when field details are not needed.
Headers
Response
OK
Example response
{
"data": {
"schemas": [
{
"fields": [
{
"id": "email",
"is_primary_key": true,
"name": "Email",
"primary_key_override": true,
"remote_type": "varchar(255)"
}
],
"id": "contact",
"name": "Contact"
}
]
}
}Changes
- breaking
the
response's property type changed fromobjectto no type for status - warning
removed the optional property
/from the response with the status - warning
removed the optional property
/from the response with the status - warning
removed the optional property
/from the response with the status - info
added to the
response propertyallOflist for the response status
- breaking
- info
added the optional property
///////to the response with the status
- info