GET
/
consumers
/
{consumerid}
/
syncs
/
{syncid}
curl --request GET \
  --url https://api.chift.eu/consumers/{consumerid}/syncs/{syncid} \
  --header 'Authorization: Bearer <token>'
{
  "syncid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sync_name": "<string>",
  "status": "active",
  "status_details": "<string>",
  "link_createdon": "2023-11-07T05:31:56Z",
  "link_mappings": [
    {
      "name": "<string>",
      "description": "<string>",
      "display_order": 0,
      "challenge_question": "<string>",
      "values": [
        {
          "source_id": "<string>",
          "target_id": "<string>"
        }
      ],
      "sub_mapping_name": "<string>",
      "sub_mapping_description": "<string>"
    }
  ],
  "link_metadata": {},
  "enabled_flows": [
    {
      "name": "<string>",
      "description": "<string>",
      "id": "<string>",
      "config": {
        "definitionFields": [
          {}
        ],
        "doorkeyFields": [
          {}
        ],
        "customFields": [
          {}
        ],
        "datastores": []
      },
      "values": {},
      "enabled_on": "2023-11-07T05:31:56Z",
      "trigger": {
        "id": "<string>",
        "type": "timer",
        "cronschedule": "<string>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

consumerid
string
required
syncid
string
required

Response

200
application/json
Successful Response
syncid
string
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

Gives additional information if the status is inactive

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

Metadata passed during creation

enabled_flows
object[]

List of flows that the consumer has enabled