Get Bulk Sync Schema

GET

https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id

GET

/api/bulk/syncs/:id/schemas/:schema_id

curl https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/Contact \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
    "destination_history_output_name": "contact__history",
    "disable_data_cutoff": false,
    "enabled": true,
    "history_enabled": false,
    "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",
        "value": null
      }
    ]
  }
}

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.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the bulk sync.

schema_idstringRequired

Source-side schema identifier.

Response

dataobjectOptional

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors