List Bulk Syncs

Create Bulk Sync

Get Bulk Sync

Update Bulk Sync

Remove Bulk Sync

Activate Bulk Sync

Start Bulk Sync Execution

Get Bulk Sync Status

Get Bulk Source

Get Bulk Destination

List Bulk Sync Execution Status

List Bulk Sync Executions

Get Bulk Sync Execution

Executions

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

Connect

Get Connection

Update Connection

Remove Connection

Connection Parameter Values

Connections

The query to execute against the connection.

Run Query

Get Query Results

Query Runner

Get Sync Source

Model Sync Field Query

Get Sync Target

Get Sync Target Fields

Get Sync Target Objects

List Syncs

Create Sync

Get Sync Schedule Options

Get Sync

Update Sync

Remove Sync

Activate Sync

Start Sync

Get Sync Status

List Executions

Get Execution

Get Execution Log Urls

Get Execution Logs

Model Sync

Refresh Connection Schema

Get Schema Status

Get Schema

Get Schema Records

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

Enrichment Fields

Preview Model

List Models

Create Model

Get Model

Update Model

Remove 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

Update Organization

Remove Organization

Organization

List Users

Create User

Get User

Update User

Remove User

Create API Key

Users

List Policies

Create Policy

Get Policy

Update Policy

Delete Policy

Policies

List Roles

Create Role

Get Role

Update Role

Delete Role

Roles

Permissions

List Webhooks

Create Webhook

Get Webhook

Update Webhook

Delete Webhook

Webhooks

APIKeyResponse

APIKeyResponseEnvelope

ActivateSyncEnvelope

ActivateSyncInput

ActivateSyncOutput

ApiError

BulkDiscover

BulkExecutionStatus

BulkField

BulkFilter

BulkItemizedSchedule

BulkMultiScheduleConfiguration

BulkSchedule

BulkSchema

BulkSchemaEnvelope

BulkSchemaExecutionStatus

BulkSelectiveMode

BulkSyncCanceledEvent

BulkSyncCompletedEvent

BulkSyncCompletedWithErrorEvent

BulkSyncDest

BulkSyncDestEnvelope

BulkSyncExecution

BulkSyncExecutionEnvelope

BulkSyncExecutionStatus

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

BulkSyncSchemaExecution

BulkSyncSchemaExecutionStatus

ID of the most recent execution for the schema.

BulkSyncSource

BulkSyncSourceEnvelope

BulkSyncSourceSchemaEnvelope

BulkSyncSourceStatus

BulkSyncSourceStatusEnvelope

BulkSyncStatusEnvelope

BulkSyncStatusResponse

ConfigurationValue

ConnectCardResponse

ConnectCardResponseEnvelope

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

GetModelSyncSourceMetaEnvelope

IdentityFunction

JobResponse

JobResponseEnvelope

JsonschemaForm

LabelLabel

ListBulkSchema

ListBulkSyncExecutionStatusEnvelope

ListBulkSyncExecutionsEnvelope

ListExecutionResponseEnvelope

ListModelSyncResponseEnvelope

Polytomic Docs

1	{
2	"data": {
3	"configuration": {
4	"table": "public.contacts"
5	},
6	"connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
7	"enricher": {
8	"connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
9	"enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
10	"fields": [
11	{
12	"description": "Unique identifier",
13	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
14	"label": "ID",
15	"name": "phone_number",
16	"remote_type": "string",
17	"type": "string",
18	"unique": true,
19	"user_added": false
20	}
21	],
22	"mappings": {
23	"mappings": "mappings"
24	}
25	},
26	"fields": [
27	{
28	"description": "Unique identifier",
29	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
30	"label": "ID",
31	"name": "id",
32	"remote_type": "string",
33	"type": "string",
34	"unique": true,
35	"user_added": false
36	}
37	],
38	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
39	"identifier": "id",
40	"labels": [
41	{}
42	],
43	"name": "Contacts",
44	"organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
45	"policies": [
46	"248df4b7-aa70-47b8-a036-33ac447e668d"
47	],
48	"relations": [
49	{
50	"from": "id"
51	}
52	],
53	"tracking_columns": [
54	"tracking_columns"
55	],
56	"type": "postgresql",
57	"version": 1
58	},
59	"job": {
60	"error": "error message",
61	"job_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
62	"result": {
63	"key": "value"
64	},
65	"status": "created",
66	"type": "createmodel"
67	}
68	}

Get Model

Path parameters

Query parameters

Response

Errors

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