Sign in
latestOpenAPI 3.0.02026-08-224362174.0 KB

24a8012aa8c8

Get Sync

Retrieve sync from sync ID

get/syncs/{syncId}

Path parameters

syncIdnumber double required

The id of the sync

Response

Ok

idnumber double required

The sync's id

slugstring required

The sync's slug

workspaceIdnumber double required

The id of the workspace that the sync belongs to

createdAtstring date-time required

The timestamp when the sync was created

updatedAtstring date-time required

The timestamp when the sync was last updated

destinationIdnumber double required

The id of the Destination that sync is connected to

modelIdnumber double required

The id of the Model that sync is connected to

configurationobject required

The sync's configuration. This specifies how data is mapped, among other configuration.

The schema depends on the destination type.

Consumers should NOT make assumptions on the contents of the configuration. It may change as Hightouch updates its internal code.

status'disabled' | 'pending' | 'cancelled' | 'failed' | 'queued' | 'success' | 'warning' | 'querying' | 'processing' | 'reporting' | 'interrupted' required

SyncStatus

disabledboolean required

Whether the sync has been disabled by the user.

lastRunAtstring date-time nullable required

The timestamp of the last sync run

referencedColumnsstring[] required

The reference column that sync depends on to sync data from source

primaryKeystring required

The primary key that sync uses to identify data from source

tagsobject required

The tags of the sync