Get Bulk Source

GET

https://app.polytomic.com/api/bulk/source/:connection_id

GET

/api/bulk/source/:connection_id

curl -G https://app.polytomic.com/api/bulk/source/248df4b7-aa70-47b8-a036-33ac447e668d \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -u "<username>:<password>" \
     -d include_fields=true

{
  "data": {
    "capabilities": {
      "supports_namespaces": true,
      "supports_selective_modes": true,
      "supports_tracking_fields": true
    },
    "configuration": null,
    "schemas": [
      {
        "fields": [
          {
            "association": {
              "id": "string",
              "name": "string",
              "reference_to": [
                "string"
              ],
              "referenced_field": "string"
            },
            "id": "email",
            "is_primary_key": true,
            "name": "Email",
            "path": "string",
            "primary_key_override": true,
            "remote_type": "varchar(255)",
            "source_primary_key": false,
            "type": "unknown",
            "type_spec": {},
            "user_managed": true,
            "values": [
              {
                "depends_on": {},
                "label": "string",
                "value": "string"
              }
            ]
          }
        ],
        "id": "contact",
        "name": "Contact"
      }
    ]
  }
}

Lists the schemas available on a connection for use as a bulk sync source.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

connection_idstringRequiredformat: "uuid"

Unique identifier of the connection

Query parameters

refresh_schemasbooleanOptionalDefaults to false

When true, refresh cached schemas synchronously before returning the response. The connection must be healthy.

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

dataobjectOptional

Bulk sync source details for the connection

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors