> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chift.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Where a consumer stands in setting up an agentic sync

> 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.



## OpenAPI

````yaml get /consumers/{consumer_id}/syncs/{syncid}/journey
openapi: 3.1.0
info:
  title: Chift API
  description: >-
    The Chift API is a universal API giving you access to financial data from
    the software of your clients. It helps software companies to offer native
    integrations to their clients without the effort needed to maintain those
    native integrations. By using the APIs (Accounting, POS, eCommerce) of
    Chift, you connect once and allow your clients to use their software
    packages.
  version: 1.0.0
servers:
  - url: https://api.chift.eu
    description: Chift
security:
  - bearerAuth: []
paths:
  /consumers/{consumer_id}/syncs/{syncid}/journey:
    get:
      tags:
        - Syncs
      summary: Where a consumer stands in setting up an agentic sync
      description: >-
        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.
      operationId: agentic_syncs_get_consumer_journey
      parameters:
        - name: consumer_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Consumer Id
        - name: syncid
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Syncid
        - name: language
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              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.
            title: Language
          description: >-
            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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Journey'
        '404':
          content:
            application/json:
              examples:
                Sync not found:
                  value:
                    message: The sync does not exist
                    status: error
                Not configured:
                  value:
                    message: The consumer is not configured for this sync
                    status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Journey:
      properties:
        enabled:
          type: boolean
          title: Enabled
          description: Whether the sync is enabled for this consumer.
        resume:
          $ref: '#/components/schemas/JourneyResume'
          description: Where to send the consumer.
        steps:
          $ref: '#/components/schemas/JourneySteps'
          description: 'Each step, in order: a step after one not complete is locked.'
      type: object
      required:
        - enabled
        - resume
        - steps
      title: Journey
      description: >-
        Where the consumer stands in setting up the sync: a status per step, and
        the step to send them to.
    ChiftError:
      properties:
        message:
          type: string
          title: Message
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
          default: error
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          default: ''
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      required:
        - message
      title: ChiftError
    HTTPValidationError:
      title: Validation Error
      required:
        - message
      type: object
      properties:
        message:
          title: Message
          type: string
          default: Validation error
        status:
          title: Status
          type: string
          default: error
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    JourneyResume:
      properties:
        step:
          type: string
          enum:
            - connections
            - capabilities
            - configuration
            - preview
            - live
          title: Step
          description: The first step not complete, or 'live' once every step is.
        sub_step:
          anyOf:
            - type: string
            - type: 'null'
          title: Sub Step
          description: Key of the step's first sub-step not complete. Null when none.
      type: object
      required:
        - step
        - sub_step
      title: JourneyResume
    JourneySteps:
      properties:
        connections:
          $ref: '#/components/schemas/JourneyStep'
          description: A connection to each vertical of the sync.
        capabilities:
          $ref: '#/components/schemas/JourneyStep'
          description: At least one main capability runs, each chosen one with its mode.
        configuration:
          $ref: '#/components/schemas/JourneyStep'
          description: >-
            Settings: every required question answered. Mappings: every mapping
            row filled and the latest preview ready.
        preview:
          $ref: '#/components/schemas/JourneyStep'
          description: Complete once the sync is enabled.
        live:
          $ref: '#/components/schemas/JourneyStep'
          description: Enabled; needs attention when a run failed since it was enabled.
      type: object
      required:
        - connections
        - capabilities
        - configuration
        - preview
        - live
      title: JourneySteps
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    JourneyStep:
      properties:
        status:
          type: string
          enum:
            - locked
            - todo
            - needs_attention
            - complete
          title: Status
          description: >-
            `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:
          items:
            $ref: '#/components/schemas/JourneySubStep'
          type: array
          title: Sub Steps
          description: >-
            The connection of each vertical, or settings then mappings. Else
            empty.
      type: object
      required:
        - status
      title: JourneyStep
    JourneySubStep:
      properties:
        key:
          type: string
          title: Key
          description: A vertical of the sync, or 'settings' or 'mappings'.
          examples:
            - accounting
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
          description: >-
            A vertical's: Name to show, in the requested language; its
            translation key without one. Null for 'settings' and 'mappings'.
        status:
          type: string
          enum:
            - locked
            - todo
            - needs_attention
            - complete
          title: Status
          description: >-
            `complete`: done. `needs_attention`: something the consumer had done
            broke, or failed. `todo`: not done yet. `locked`: an earlier step is
            not complete.
      type: object
      required:
        - key
        - title
        - status
      title: JourneySubStep
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        This access token needs to be included in each of your request to the
        Chift API.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.