---
title: "Get Bulk Source"
method: GET
path: "/api/connections/{id}/bulksync/source"
tags: ["Bulk Sync"]
---

# Get Bulk Source

`GET /api/connections/{id}/bulksync/source`

Lists the schemas (tables or objects) available on a connection for use as a bulk sync source, optionally including per-schema field details.

The response reflects what the
connection currently has cached; if the upstream source has changed, trigger
a refresh first with
[`POST /api/connections/{id}/schemas/refresh`](../../../../../api-reference/schemas/refresh).

These are the schemas available for selection, not the schemas already
configured on any particular sync. To inspect schemas on a running sync, use
[`GET /api/bulk/syncs/{id}/schemas`](../../../../../api-reference/bulk-sync/schemas/list).

Pass `include_fields=true` to receive per-schema field details in a single call.
Omit it when you only need the schema list, as field enumeration can be slow for
large sources.

## Path parameters

- `id` string, uuid, required — Unique identifier of the connection.

## Query parameters

- `include_fields` boolean — When true, include per-schema field lists in the response. Set to false for a smaller payload when field details are not needed.

## Headers

- `X-Polytomic-Version` string

## Response `200`

OK

- BulkSyncSourceEnvelope
  - `data` BulkSyncSource
    - `capabilities` BulkSyncSourceCapabilities
      - `supports_tracking_fields` boolean
    - `configuration` unknown
    - `schemas` Schema[], nullable
      - `fields` SchemaField[]
        - `association` SchemaAssociation
          - `id` string
          - `name` string
          - `reference_to` string[]
          - `referenced_field` string
        - `id` string
        - `is_primary_key` boolean — Whether this field is part of the schema's primary key, including any user override.
        - `name` string
        - `path` string — JSONPath used to extract the field from each source record; only meaningful for document-style backends.
        - `remote_type` string — The type of the field from the remote system.
        - `type` 'unknown' | 'string' | 'number' | 'boolean' | 'datetime' | 'array' | 'object' | 'binary'
        - `type_spec` unknown
        - `user_managed` boolean — True when the field's effective definition came from a user override.
        - `values` PickValue[]
          - `label` string
          - `value` string
      - `id` string
      - `name` string

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `500` — Internal Server Error

---

[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)