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

# The objects of one type a consumer's sync handled

> One page of them, the latest changed first. `kind` is the object's type, e.g. `supplier_invoice`; read one with `GET …/objects/{kind}/{object_id}`.



## OpenAPI

````yaml get /consumers/{consumer_id}/syncs/{syncid}/objects/{kind}
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}/objects/{kind}:
    get:
      tags:
        - Syncs
      summary: The objects of one type a consumer's sync handled
      description: >-
        One page of them, the latest changed first. `kind` is the object's type,
        e.g. `supplier_invoice`; read one with `GET
        …/objects/{kind}/{object_id}`.
      operationId: agentic_syncs_get_objects
      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: kind
          in: path
          required: true
          schema:
            type: string
            title: Kind
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Only the objects in this status, e.g. 'failed'.
            title: Status
          description: Only the objects in this status, e.g. 'failed'.
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Only the objects whose source or target id contains it.
            title: Search
          description: Only the objects whose source or target id contains it.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
        - name: size
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            default: 50
            title: Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChiftPage_ObjectItem_'
        '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
                Object not found:
                  value:
                    message: The object does not exist
                    status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ChiftPage_ObjectItem_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ObjectItem'
          type: array
          title: Items
        total:
          type: integer
          minimum: 0
          title: Total
        page:
          type: integer
          minimum: 1
          title: Page
        size:
          type: integer
          minimum: 1
          title: Size
      type: object
      required:
        - items
        - total
        - page
        - size
      title: ChiftPage[ObjectItem]
    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'
    ObjectItem:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: 'The object''s id: read it with `GET …/objects/{kind}/{id}`.'
        kind:
          type: string
          title: Kind
          description: The object's type, e.g. 'supplier_invoice'.
        capability:
          type: string
          title: Capability
          description: Key of the capability that handles it.
        source_id:
          type: string
          title: Source Id
          description: Its id in the source.
        scope:
          additionalProperties:
            type: string
          type: object
          title: Scope
          description: >-
            What identifies it beside its source id, for a sync keying its
            objects on something the consumer runs several of: `{"location_id":
            "paris"}`. Empty otherwise.
        status:
          type: string
          title: Status
          description: >-
            Where it stands, e.g. 'pending', 'success', 'failed', 'skipped',
            'never_retry'.
        target_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Target Id
          description: What it was booked as in the target. Null until then.
        booked_as:
          anyOf:
            - type: string
            - type: 'null'
          title: Booked As
          description: Key of the mode that booked it.
        attempts:
          type: integer
          title: Attempts
          description: How many times it failed.
        last_error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Error Code
          description: The code of its last failure.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the sync first saw it.
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: When it last changed.
        succeeded_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Succeeded At
          description: When it was booked.
      type: object
      required:
        - id
        - kind
        - capability
        - source_id
        - scope
        - status
        - target_id
        - booked_as
        - attempts
        - last_error_code
        - created_at
        - updated_at
        - succeeded_at
      title: ObjectItem
    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
  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.