Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Bulk Sync

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

get/api/bulk/syncs/{id}/schemas

Path parameters

idstring uuid required

Unique identifier of the bulk sync.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the bulk sync.

Query parameters

filtersobject

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

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

{
  "enabled": true
}

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": [
    {
      "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
      "enabled": true,
      "id": "Contact",
      "output_name": "contact",
      "partition_key": "email",
      "tracking_field": "updated_at",
      "user_output_name": "my_contact"
    }
  ]
}