For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETList Bulk Syncs
      • POSTCreate Bulk Sync
      • GETGet Bulk Sync
      • PUTUpdate Bulk Sync
      • DELDelete Bulk Sync
      • POSTActivate Bulk Sync
      • POSTCancel Bulk Sync
      • POSTStart Bulk Sync Execution
      • GETGet Bulk Sync Status
      • GETGet Bulk Source
      • GETGet Bulk Destination
        • GETGet Bulk Sync Schemas
        • PATCHUpdate Bulk Sync Schemas
        • GETGet Bulk Sync Schema
        • PUTUpdate Bulk Sync Schema
        • POSTCancel Bulk Sync Schema
Logo
Log inBook a demo
API ReferenceBulk SyncSchemas

Get Bulk Sync Schemas

GET
https://app.polytomic.com/api/bulk/syncs/:id/schemas
GET
/api/bulk/syncs/:id/schemas
$curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas \
>     -H "Authorization: Bearer <token>"
1{
2  "data": [
3    {
4      "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
5      "disable_data_cutoff": false,
6      "enabled": true,
7      "id": "Contact",
8      "output_name": "contact",
9      "partition_key": "email",
10      "tracking_field": "updated_at",
11      "user_output_name": "my_contact"
12    }
13  ]
14}
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).
Was this page helpful?
Previous

Update Bulk Sync Schemas

Next

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 or PUT /api/bulk/syncs/{id}/schemas/{schema_id}.

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