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

# Get Bulk Sync

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

Returns a bulk sync by ID.

The response includes the sync's top-level configuration — source, destination,
schedules, and discovery settings.

- To check whether the sync is running and see the most-recent execution result,
  use [`GET /api/bulk/syncs/{id}/status`](../../../../api-reference/bulk-sync/get-status).
- To inspect which schemas are selected and how they are configured, use
  [`GET /api/bulk/syncs/{id}/schemas`](../../../../api-reference/bulk-sync/schemas/list).

## Path parameters

- `id` string, uuid, required

## Query parameters

- `refresh_schemas` boolean

## Headers

- `X-Polytomic-Version` string

## Response `200`

OK

- BulkSyncResponseEnvelope
  - `data` BulkSyncResponse
    - `active` boolean — Whether the sync is active. Inactive syncs do not run on their schedule.
    - `additional_schedules` BulkSyncAdditionalScheduleResponse[], nullable — Additional bulk sync schedules. Schedule times are interpreted in UTC.
      - `created_at` string, date-time — Timestamp the schedule was created.
      - `created_by` OutputActor
        - `id` string, uuid
        - `name` string
        - `type` string
      - `day_of_month` string — Day of the month (1-31) for monthly schedules.
      - `day_of_week` string — Day of the week for weekly schedules.
      - `frequency` 'manual' | 'continuous' | 'hourly' | 'daily' | 'weekly' | 'custom' | 'builder' | 'runafter' | 'multi' | 'dbtcloud', required
      - `hour` string — Hour of the day (0-23, in UTC) the schedule fires.
      - `id` string, uuid — Unique identifier of the schedule.
      - `minute` string — Minute of the hour (0-59) the schedule fires.
      - `month` string — Month of the year (1-12) for yearly schedules.
      - `resync_mode` 'normal' | 'refetch' | 'resync' | 'rebuild'
      - `schemas` string[] — Schema IDs this schedule applies to. Empty means all schemas.
      - `selective_mode` 'none' | 'incrementalFields' | 'nonincrementalFields'
      - `updated_at` string, date-time — Timestamp the schedule was last updated.
      - `updated_by` OutputActor
        - `id` string, uuid
        - `name` string
        - `type` string
    - `automatically_add_new_fields` 'all' | 'onlyIncremental' | 'onlyNonIncremental' | 'none', nullable
    - `automatically_add_new_objects` 'all' | 'onlyIncremental' | 'onlyNonIncremental' | 'none', nullable
    - `concurrency_limit` integer, nullable — Per-sync concurrency limit override.
    - `created_at` string, date-time — Timestamp the sync was created.
    - `created_by` OutputActor
      - `id` string, uuid
      - `name` string
      - `type` string
    - `data_cutoff_timestamp` string, date-time, nullable — Global cutoff applied across schemas; source records older than this timestamp are excluded.
    - `default_schedule` BulkSyncDefaultScheduleResponse
      - `created_at` string, date-time — Timestamp the schedule was created.
      - `created_by` OutputActor
        - `id` string, uuid
        - `name` string
        - `type` string
      - `day_of_month` string — Day of the month (1-31) for monthly schedules.
      - `day_of_week` string — Day of the week for weekly schedules.
      - `frequency` 'manual' | 'continuous' | 'hourly' | 'daily' | 'weekly' | 'custom' | 'builder' | 'runafter' | 'multi' | 'dbtcloud', required
      - `hour` string — Hour of the day (0-23, in UTC) the schedule fires.
      - `id` string, uuid — Unique identifier of the schedule.
      - `minute` string — Minute of the hour (0-59) the schedule fires.
      - `month` string — Month of the year (1-12) for yearly schedules.
      - `updated_at` string, date-time — Timestamp the schedule was last updated.
      - `updated_by` OutputActor
        - `id` string, uuid
        - `name` string
        - `type` string
    - `destination_configuration` object, nullable — Destination-specific bulk sync configuration. e.g. output schema name, s3 file format, etc.
    - `destination_connection_id` string, uuid — Connection rows are written to.
    - `disable_record_timestamps` boolean — When true, Polytomic does not add its own timestamp columns to destination rows.
    - `id` string, uuid — Unique identifier of the bulk sync.
    - `mode` 'snapshot' | 'replicate', nullable
    - `name` string — Human-readable name of the bulk sync.
    - `normalize_names` 'enabled' | 'disabled' | 'legacy', nullable
    - `organization_id` string, uuid — Organization the sync belongs to.
    - `policies` string[] — List of permissions policies applied to the bulk sync.
    - `resync_concurrency_limit` integer, nullable — Per-sync resync concurrency limit override.
    - `source_configuration` object, nullable — Source-specific bulk sync configuration. e.g. replication slot name, sync lookback, etc.
    - `source_connection_id` string, uuid — Connection rows are read from.
    - `updated_at` string, date-time — Timestamp the sync was last updated.
    - `updated_by` OutputActor
      - `id` string, uuid
      - `name` string
      - `type` 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/b509e00e80aa/schema)