Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Bulk Sync

Get Bulk 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.

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.

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.

get/api/connections/{id}/bulksync/source

Path parameters

idstring uuid required

Unique identifier of the connection.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the connection.

Query parameters

include_fieldsboolean

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

Example:true

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-Versionstring

Response

OK

Example response

{
  "data": {
    "schemas": [
      {
        "fields": [
          {
            "id": "email",
            "is_primary_key": true,
            "name": "Email",
            "remote_type": "varchar(255)"
          }
        ],
        "id": "contact",
        "name": "Contact"
      }
    ]
  }
}