Get Bulk Destination

Get Bulk Source

List Bulk Syncs

Create Bulk Sync

Get Bulk Sync

Remove Bulk Sync

Update Bulk Sync

Activate Bulk Sync

Get Bulk Sync Schemas

Update Bulk Sync Schemas

Get Bulk Sync Schema

Update Bulk Sync Schema

Schemas

Bulk Sync

Get Connection Types

List Connections

Create Connection

Get Connection

Remove Connection

Update Connection

Connection Parameter Values

Get Connection Source

Connection Field Query

Get Connection Target

Get Connection Target Fields

Connections

For a given connection and enrichment configuration, provides the valid sets of input fields.

Enrichment Fields

Preview Model

List Models

Create Model

Get Model

Remove Model

Update Model

Returns sample records from the model. The first ten records that the source provides will be returned after being enriched (if applicable). Synchronous requests must complete within 10s. If either querying or enrichment exceeds 10s, please use the async option.

Sample Records

Models

Get Events

Get Event Types

Events

Get Job

Jobs

Get Identity

Identity

Get Organizations

Create Organization

Get Organization

Remove Organization

Update Organization

Organization

List Users

Create User

Get User

Remove User

Update User

Create API Key

Users

List Policies

Create Policy

Get Policy

Delete Policy

Update Policy

Policies

List Roles

Create Role

Get Role

Delete Role

Update Role

Roles

Permissions

List Syncs

Create Sync

Get Sync Schedule Options

Get Sync

Remove Sync

Update Sync

Activate Sync

Start Sync

Get Sync Status

List Executions

Get Execution

Get Execution Log Urls

Get Execution Logs

Executions

Model Sync

List Webhooks

Create Webhook

Get Webhook

Delete Webhook

Update Webhook

Webhooks

APIKeyResponse

APIKeyResponseEnvelope

ActivateSyncEnvelope

ActivateSyncInput

ActivateSyncOutput

ApiError

BulkDiscover

BulkFilter

BulkItemizedSchedule

BulkMultiScheduleConfiguration

BulkSchedule

BulkSchema

BulkSchemaEnvelope

BulkSelectiveMode

BulkSyncCanceledEvent

BulkSyncCompletedEvent

BulkSyncCompletedWithErrorEvent

BulkSyncDest

BulkSyncDestEnvelope

BulkSyncFailedEvent

BulkSyncListEnvelope

BulkSyncResponse

Destination-specific bulk sync configuration. e.g. output schema name, s3 file format, etc.

List of permissions policies applied to the bulk sync.

Source-specific bulk sync configuration. e.g. replication slot name, sync lookback, etc.

BulkSyncResponseEnvelope

BulkSyncRunningEvent

BulkSyncSource

BulkSyncSourceEnvelope

ConfigurationValue

ConnectionListResponseEnvelope

ConnectionMeta

ConnectionMetaResponse

ConnectionParameterValue

ConnectionParameterValuesResp

ConnectionParameterValuesResponseEnvelope

ConnectionResponseEnvelope

ConnectionResponseSchema

API calls made to service in the last 24h (supported integrations only).

ConnectionType

ConnectionTypeResponseEnvelope

ConnectionTypeSchema

CreateConnectionResponseEnvelope

CreateConnectionResponseSchema

Code to enter in order to complete connection authentication.

URL to visit to complete connection authentication.

CreateModelRequest

Enrichment

Must be provided to update an existing enrichment

If not provided, all fields will be enabled.

Event

EventBody

EventTypesEnvelope

EventsEnvelope

ExecutionCounts

ExecutionLogResponse

ExecutionLogsResponseEnvelope

ExecutionStatus

FieldConfiguration

Whether the field is enabled for syncing.

Filter

FilterFieldReferenceType

FilterFunction

GetConnectionMetaEnvelope

GetExecutionResponseEnvelope

GetExecutionResponseSchema

GetIdentityResponseEnvelope

GetIdentityResponseSchema

IdentityFunction

JobResponse

JobResponseEnvelope

JsonschemaForm

LabelLabel

ListBulkSchemaEnvelope

ListExecutionResponseEnvelope

ListModelSyncResponseEnvelope

ListPoliciesResponseEnvelope

ListUsersEnvelope

Mode

ModelField

ModelFieldResponse

ModelListResponseEnvelope

ModelModelFieldRequest

ModelRelation

ModelRelationTo

ModelResponse

ModelResponseEnvelope

ModelSample

ModelSampleResponseEnvelope

ModelSyncField

New is set to true if the target field should be created by Polytomic. This is not supported by all backends.

Value to set in the target field; if provided, 'source' is ignored.

Sync mode for the field; defaults to 'updateOrCreate'. If set to 'create', the field will not be synced if it already has a value. This is not supported by all backends.

1	{
2	"data": {
3	"configuration": {
4	"advanced": {
5	"items": {
6	"truncate_existing": {
7	"default": "",
8	"required": false
9	}
10	}
11	},
12	"mirror_schemas": {
13	"default": "",
14	"required": false
15	},
16	"schema": {
17	"default": "",
18	"required": false
19	}
20	},
21	"modes": [
22	{
23	"description": "Replace all records",
24	"label": "Replace",
25	"requires_identity": false,
26	"supports_field_sync_mode": false,
27	"supports_target_filters": false
28	}
29	]
30	}
31	}

1	curl https://app.polytomic.com/api/bulk/dest/248df4b7-aa70-47b8-a036-33ac447e668d \
2	-H "Authorization: Bearer <token>"

Get Bulk Destination

Path parameters

Response