CHchift
Syncs

Where a consumer stands in setting up an agentic sync

Changed on

A status per step of the setup (connections, capabilities, configuration, preview, live) and the step to send the consumer to. A step after one not complete is locked.

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

Request

Path parameters

consumer_idstring uuid required
syncidstring uuid required

Query parameters

languagestring nullable

ISO 639-1 code of the language of the texts (en, fr, nl, de, es; any case), falling back to English. Without it, translation keys.

Response

Successful Response

enabledboolean required

Whether the sync is enabled for this consumer.

Example response

{
  "steps": {
    "connections": {
      "sub_steps": [
        {
          "key": "accounting"
        }
      ]
    },
    "capabilities": {
      "sub_steps": [
        {
          "key": "accounting"
        }
      ]
    },
    "configuration": {
      "sub_steps": [
        {
          "key": "accounting"
        }
      ]
    },
    "preview": {
      "sub_steps": [
        {
          "key": "accounting"
        }
      ]
    },
    "live": {
      "sub_steps": [
        {
          "key": "accounting"
        }
      ]
    }
  }
}

Changes