Skip to main content
GET
Get sync information for one consumer
Learn more:
  • What are Syncs? ↗
  • How to activate a Sync? ↗
  • How to expose a Sync to end-users? ↗

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

consumer_id
string<uuid>
required
syncid
string<uuid>
required

Query Parameters

preview_executionid
string<uuid> | null

Response

Successful Response

syncid
string<uuid>
required
sync_name
string
required

Name of the sync

Date on which the consumer first navigated to the link to setup the sync

status
enum<string>
default:inactive

Indicates whether the consumer has setup the sync. If the setup is complete, it will return 'active'. Otherwise 'inactive'.

Available options:
active,
inactive
status_details
string | null

Gives additional information if the status is inactive

enabled
boolean
default:false

True when the consumer has enabled at least one default flow of the sync. Same rule as the 'enabled' status of the dashboard and the consumers_status filter of GET /syncs.

Values of the mappings requested for the sync for the specific consumer

skip_mappings
ReadSyncSkipMappingItem · object[] | null

List of mappings which are ignored due to specific configuration of the consumer

Metadata passed during creation

Values of the presync configuration for the sync for the specific consumer

enabled_flows
ReadFlowConsumerItem · object[] | null

List of flows that the consumer has enabled