v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB

Bulk Sync

Get Bulk Sync Schema

Returns the configuration of a single schema on a bulk sync.

Returns the sync mode, field selections, and any other configuration applied to this schema on the bulk sync.

To modify the configuration, use PATCH /api/bulk/syncs/{id}/schemas for a partial update across multiple schemas, or PUT /api/bulk/syncs/{id}/schemas/{schema_id} to fully replace this schema's configuration.

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

Path parameters

idstring uuid required

Unique identifier of the bulk sync.

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

Unique identifier of the bulk sync.

schema_idstring required

Source-side schema identifier.

Example:Contact

Source-side schema identifier.

Headers

X-Polytomic-Versionstring

Response

Example response

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