Get Bulk Sync Schemas | Polytomic Docs

curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -u "<username>:<password>"

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

Lists the schemas configured on 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}.

Lists the schemas configured on 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).

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the bulk sync.

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

datalist of objects or null

Errors

401

Unauthorized Error

404

Not Found Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors