v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Consumers

Get sync information for one consumer

Returns sync information (creation date, mapping) related to a specific consumer

get/consumers/{consumer_id}/syncs/{syncid}

Path parameters

consumer_idstring uuid required
syncidstring uuid required

Query parameters

preview_executionidstring uuid nullable

Response

Successful Response

syncidstring uuid required
sync_namestring required

Name of the sync

status'active' | 'inactive'
status_detailsstring nullable

Gives additional information if the status is inactive

link_createdonstring date-time required

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

link_metadataobject nullable

Metadata passed during creation

link_presyncobject nullable

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