CHchift
Consumers

Get sync information for one consumer

Changed on

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

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

Request

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

enabledboolean

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.

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

Changes

  • 020884969534Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status