---
title: "Get Bulk Sync Schema"
method: GET
path: "/api/bulk/syncs/{id}/schemas/{schema_id}"
tags: ["Bulk Sync"]
---

# Get Bulk Sync Schema

`GET /api/bulk/syncs/{id}/schemas/{schema_id}`

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`](../../../../../../api-reference/bulk-sync/schemas/patch)
for a partial update across multiple schemas, or
[`PUT /api/bulk/syncs/{id}/schemas/{schema_id}`](../../../../../../api-reference/bulk-sync/schemas/update)
to fully replace this schema's configuration.

## Path parameters

- `id` string, uuid, required — Unique identifier of the bulk sync.
- `schema_id` string, required — Source-side schema identifier.

## Headers

- `X-Polytomic-Version` string

## Response `200`

OK

- BulkSchemaEnvelope
  - `data` BulkSchema
    - `data_cutoff_timestamp` string, date-time, nullable
    - `disable_data_cutoff` boolean
    - `enabled` boolean
    - `fields` BulkField[] — fields is not populated on the list endpoint and will be removed in a future version; retrieve individual schemas for fields.
      - `enabled` boolean
      - `id` string
      - `obfuscated` boolean
      - `output_name` string
      - `user_output_name` string
    - `filters` BulkFilter[] — filters is not populated on the list endpoint and will be removed in a future version; retrieve individual schemas for filters.
      - `field_id` string — Schema field ID to filter on.
      - `function` 'Equality' | 'Inequality' | 'IsNull' | 'IsNotNull' | 'True' | 'False' | 'OnOrAfter' | 'OnOrBefore' | 'GreaterThan' | 'GreaterThanEqual' | 'LessThan' | 'LessThanEqual' | 'StringContains' | 'StringStartsWith' | 'StringEndsWith' | 'StringDoesNotContain' | 'StringDoesNotStartWith' | 'StringDoesNotEndWith' | 'StringOneOf' | 'StringNotOneOf' | 'Between' | 'ArrayContains' | 'ArrayDoesNotContain' | 'InTheLast' | 'RelativeOnOrBefore' | 'RelativeOnOrAfter' | 'StringLike' | 'StringNotLike' | 'StringMatchesTrimmed', required
      - `value` string
    - `id` string
    - `output_name` string
    - `partition_key` string
    - `tracking_field` string
    - `user_output_name` string

## Other responses

- `404` — Not Found

---

[API](https://skmtc.net/polytomic/apis/polytomic-api.md) · [All operations](https://skmtc.net/polytomic/apis/polytomic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polytomic/polytomic-api/versions/5e9bcd4cfb2d/schema)