--- title: "Where a consumer stands in setting up an agentic sync" method: GET path: "/consumers/{consumer_id}/syncs/{syncid}/journey" tags: ["Syncs"] --- # Where a consumer stands in setting up an agentic sync `GET /consumers/{consumer_id}/syncs/{syncid}/journey` ## Request - Base URL: `https://api.chift.eu` - URL: `https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/journey` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) 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. ## Path parameters - `consumer_id` string, uuid, required - `syncid` string, uuid, required ## Query parameters - `language` string, 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 `200` Successful Response - Journey: Where the consumer stands in setting up the sync: a status per step, and the step to send them to. - `enabled` boolean, required: Whether the sync is enabled for this consumer. - `resume` JourneyResume, required - `step` 'connections' | 'capabilities' | 'configuration' | 'preview' | 'live', required: The first step not complete, or 'live' once every step is. - `sub_step` string, nullable, required: Key of the step's first sub-step not complete. Null when none. - `steps` JourneySteps, required - `connections` JourneyStep, required - `status` 'locked' | 'todo' | 'needs_attention' | 'complete', required: `complete`: done. `needs_attention`: something the consumer had done broke, or failed. `todo`: not done yet. `locked`: an earlier step is not complete. - `sub_steps` JourneySubStep[]: The connection of each vertical, or settings then mappings. Else empty. - `key` string, required: A vertical of the sync, or 'settings' or 'mappings'. - `title` string, nullable, required: A vertical's: Name to show, in the requested language; its translation key without one. Null for 'settings' and 'mappings'. - `status` 'locked' | 'todo' | 'needs_attention' | 'complete', required: `complete`: done. `needs_attention`: something the consumer had done broke, or failed. `todo`: not done yet. `locked`: an earlier step is not complete. - `capabilities` JourneyStep, required - `status` 'locked' | 'todo' | 'needs_attention' | 'complete', required: `complete`: done. `needs_attention`: something the consumer had done broke, or failed. `todo`: not done yet. `locked`: an earlier step is not complete. - `sub_steps` JourneySubStep[]: The connection of each vertical, or settings then mappings. Else empty. - `key` string, required: A vertical of the sync, or 'settings' or 'mappings'. - `title` string, nullable, required: A vertical's: Name to show, in the requested language; its translation key without one. Null for 'settings' and 'mappings'. - `status` 'locked' | 'todo' | 'needs_attention' | 'complete', required: `complete`: done. `needs_attention`: something the consumer had done broke, or failed. `todo`: not done yet. `locked`: an earlier step is not complete. - `configuration` JourneyStep, required - `status` 'locked' | 'todo' | 'needs_attention' | 'complete', required: `complete`: done. `needs_attention`: something the consumer had done broke, or failed. `todo`: not done yet. `locked`: an earlier step is not complete. - `sub_steps` JourneySubStep[]: The connection of each vertical, or settings then mappings. Else empty. - `key` string, required: A vertical of the sync, or 'settings' or 'mappings'. - `title` string, nullable, required: A vertical's: Name to show, in the requested language; its translation key without one. Null for 'settings' and 'mappings'. - `status` 'locked' | 'todo' | 'needs_attention' | 'complete', required: `complete`: done. `needs_attention`: something the consumer had done broke, or failed. `todo`: not done yet. `locked`: an earlier step is not complete. - `preview` JourneyStep, required - `status` 'locked' | 'todo' | 'needs_attention' | 'complete', required: `complete`: done. `needs_attention`: something the consumer had done broke, or failed. `todo`: not done yet. `locked`: an earlier step is not complete. - `sub_steps` JourneySubStep[]: The connection of each vertical, or settings then mappings. Else empty. - `key` string, required: A vertical of the sync, or 'settings' or 'mappings'. - `title` string, nullable, required: A vertical's: Name to show, in the requested language; its translation key without one. Null for 'settings' and 'mappings'. - `status` 'locked' | 'todo' | 'needs_attention' | 'complete', required: `complete`: done. `needs_attention`: something the consumer had done broke, or failed. `todo`: not done yet. `locked`: an earlier step is not complete. - `live` JourneyStep, required - `status` 'locked' | 'todo' | 'needs_attention' | 'complete', required: `complete`: done. `needs_attention`: something the consumer had done broke, or failed. `todo`: not done yet. `locked`: an earlier step is not complete. - `sub_steps` JourneySubStep[]: The connection of each vertical, or settings then mappings. Else empty. - `key` string, required: A vertical of the sync, or 'settings' or 'mappings'. - `title` string, nullable, required: A vertical's: Name to show, in the requested language; its translation key without one. Null for 'settings' and 'mappings'. - `status` 'locked' | 'todo' | 'needs_attention' | 'complete', required: `complete`: done. `needs_attention`: something the consumer had done broke, or failed. `todo`: not done yet. `locked`: an earlier step is not complete. ## Other responses - `404`: Not Found - `422`: Validation Error ## Changes - **2026-11-03** `020884969534`: 1 info - endpoint added [Operation history](https://skmtc.dev/chift/apis/chift-api/changes/consumers/:consumer_id/syncs/:syncid/journey/get.md) --- [API](https://skmtc.dev/chift/apis/chift-api.md) - [All operations](https://skmtc.dev/chift/apis/chift-api/llms.txt) - [OpenAPI document](https://skmtc.dev/chift/apis/chift-api/revisions/020884969534?raw)