Get Bulk Source

curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/bulksync/source \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "data": {
    "capabilities": {
      "supports_tracking_fields": true
    },
    "configuration": {},
    "schemas": [
      {
        "fields": [
          {
            "association": {
              "id": "fk_contact_account",
              "name": "Account Relationship",
              "reference_to": [
                "account"
              ],
              "referenced_field": "account_id"
            },
            "id": "email",
            "is_primary_key": true,
            "name": "Email",
            "path": "$.email",
            "remote_type": "varchar(255)",
            "type": "string",
            "user_managed": true,
            "values": [
              {
                "label": "Work Email",
                "value": "work"
              },
              {
                "label": "Personal Email",
                "value": "personal"
              }
            ]
          },
          {
            "association": null,
            "id": "first_name",
            "is_primary_key": false,
            "name": "First Name",
            "path": "$.firstName",
            "remote_type": "varchar(100)",
            "type": "string",
            "user_managed": false,
            "values": []
          },
          {
            "association": null,
            "id": "created_at",
            "is_primary_key": false,
            "name": "Created At",
            "path": "$.createdAt",
            "remote_type": "timestamp",
            "type": "datetime",
            "user_managed": false,
            "values": []
          }
        ],
        "id": "contact",
        "name": "Contact"
      },
      {
        "fields": [
          {
            "association": null,
            "id": "account_id",
            "is_primary_key": true,
            "name": "Account ID",
            "path": "$.id",
            "remote_type": "uuid",
            "type": "string",
            "user_managed": false,
            "values": []
          },
          {
            "association": null,
            "id": "account_name",
            "is_primary_key": false,
            "name": "Account Name",
            "path": "$.name",
            "remote_type": "varchar(255)",
            "type": "string",
            "user_managed": false,
            "values": []
          }
        ],
        "id": "account",
        "name": "Account"
      }
    ]
  }
}

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.

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.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the connection.

Query parameters

include_fieldsbooleanOptionalDefaults to true

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

Response

dataobject

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors

Authentication

Path parameters

Headers

Query parameters

Response

Errors