HIhightouch

Get Sync

Changed on

Retrieve sync from sync ID

get/syncs/{syncId}

Request

  • Base URL
    https://api.hightouch.com/api/v1
  • Auth
    HTTP bearer

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.

For a sync bound to a sync template this is the effective configuration: the template's configuration with this sync's syncTemplateOverrides applied.

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

syncTemplateIdnumber double nullable required

The id of the sync template this sync is bound to, or null when the sync owns its configuration. A bound sync takes its destination and configuration from the template and follows later changes to the template; configuration is the effective merged configuration and syncTemplateOverrides holds this sync's own values.

syncTemplateOverridesobject nullable required

The template configuration fields this sync overrides, keyed by configuration field path (for example "externalIdMapping" or "target.schema"). Null when the sync is not bound to a sync template or has no overrides.

Changes

  • 2e05cc6b427bRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5574262d4032Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status