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

# Read the list

> The open items in groups and the bought items, latest first. Without `place` (Todos) the groups are places, in creation order; with it they are that place's sections, with the items of no section last. `soon` ("Prazo curto") holds the open items due by today plus two days in America/Sao_Paulo, overdue included, by due date, and takes them out of their groups. An item's `due` is its deadline; `origin` names the activity whose requirement derived it, and a derived item loses its `due` once that occurrence is cancelled.



## OpenAPI

````yaml /openapi.json get /v1/shopping/items
openapi: 3.0.0
info:
  title: onosso
  version: 0.0.0
  description: >-
    The household's API: the week, the people and the sessions the web app reads
    and changes.
servers: []
security: []
tags:
  - name: Week
    description: The household's week, day by day.
  - name: People
    description: The people who make up the household.
  - name: Pets
    description: The pets of the house.
  - name: Invites
    description: Links that let someone join.
  - name: Sessions
    description: Where you are signed in.
  - name: Tokens
    description: Your personal API tokens.
  - name: Address
    description: Where the household lives.
  - name: Messages
    description: What each person receives from the product, and when.
  - name: Questions
    description: 'What needs a person: one queue, the same in the app and on WhatsApp.'
  - name: Shopping
    description: 'The household''s one list: places, items and marks.'
  - name: Conversation
    description: >-
      Each person's one conversation with the assistant, the same in the app and
      on WhatsApp.
  - name: MCP
    description: The house for an MCP client such as Claude Desktop, with a personal token.
paths:
  /v1/shopping/items:
    get:
      tags:
        - Shopping
      summary: Read the list
      description: >-
        The open items in groups and the bought items, latest first. Without
        `place` (Todos) the groups are places, in creation order; with it they
        are that place's sections, with the items of no section last. `soon`
        ("Prazo curto") holds the open items due by today plus two days in
        America/Sao_Paulo, overdue included, by due date, and takes them out of
        their groups. An item's `due` is its deadline; `origin` names the
        activity whose requirement derived it, and a derived item loses its
        `due` once that occurrence is cancelled.
      parameters:
        - schema:
            type: string
            maxLength: 64
          required: false
          name: place
          in: query
      responses:
        '200':
          description: The list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShoppingList'
        '401':
          $ref: '#/components/responses/ShoppingUnauthorized'
        '404':
          $ref: '#/components/responses/ShoppingNotFound'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/RequestTimeout'
      security:
        - session: []
        - token: []
components:
  schemas:
    ShoppingList:
      type: object
      properties:
        placeId:
          type: string
          nullable: true
        open:
          type: array
          items:
            oneOf:
              - type: object
                properties:
                  kind:
                    type: string
                    enum:
                      - place
                  placeId:
                    type: string
                  title:
                    type: string
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ShoppingListItem'
                required:
                  - kind
                  - placeId
                  - title
                  - items
              - type: object
                properties:
                  kind:
                    type: string
                    enum:
                      - section
                  section:
                    type: string
                    nullable: true
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ShoppingListItem'
                required:
                  - kind
                  - section
                  - items
        bought:
          type: array
          items:
            $ref: '#/components/schemas/ShoppingListItem'
        soon:
          type: array
          items:
            $ref: '#/components/schemas/ShoppingListItem'
      required:
        - placeId
        - open
        - bought
        - soon
    ShoppingListItem:
      allOf:
        - $ref: '#/components/schemas/ShoppingItem'
        - type: object
          properties:
            due:
              type: string
              nullable: true
              format: date
            origin:
              type: object
              nullable: true
              properties:
                requirementId:
                  type: string
                label:
                  type: string
              required:
                - requirementId
                - label
          required:
            - due
            - origin
    Unauthorized:
      type: object
      properties:
        message:
          type: string
          enum:
            - Unauthorized
        statusCode:
          type: number
          enum:
            - 401
      required:
        - message
        - statusCode
    DomainError:
      type: object
      properties:
        code:
          type: string
        details:
          type: object
          additionalProperties:
            nullable: true
      required:
        - code
        - details
    Degraded:
      type: object
      properties:
        code:
          type: string
          enum:
            - request.timeout
            - service.unavailable
        correlationId:
          type: string
      required:
        - code
        - correlationId
    ShoppingItem:
      type: object
      properties:
        id:
          type: string
        version:
          type: string
        placeId:
          type: string
        name:
          type: string
        quantity:
          type: string
          nullable: true
        section:
          type: string
          nullable: true
        bought:
          type: boolean
        placeConfidence:
          type: string
          enum:
            - confirmed
            - assumed
        addedBy:
          type: object
          properties:
            personId:
              type: string
            displayName:
              type: string
          required:
            - personId
            - displayName
        addedAt:
          type: string
          format: date-time
        changedBy:
          type: object
          properties:
            personId:
              type: string
            displayName:
              type: string
          required:
            - personId
            - displayName
        changedAt:
          type: string
          format: date-time
      required:
        - id
        - version
        - placeId
        - name
        - quantity
        - section
        - bought
        - placeConfidence
        - addedBy
        - addedAt
        - changedBy
        - changedAt
  responses:
    ShoppingUnauthorized:
      description: The session is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Unauthorized'
    ShoppingNotFound:
      description: >-
        The place, the item, the decline or the menu choice is not in the
        caller's household.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DomainError'
    ServiceUnavailable:
      description: A dependency is unavailable; retry after Retry-After seconds.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Degraded'
    RequestTimeout:
      description: The request outlived its deadline.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Degraded'
  securitySchemes:
    session:
      type: apiKey
      in: cookie
      name: __Secure-better-auth.session_token
      description: The session cookie set when you sign in to the web app.
    token:
      type: http
      scheme: bearer
      description: >-
        A personal API token (`onss_live_…`), created in Ajustes › Integrações.
        It acts as the person who created it, in the household it was created
        in, on the read routes that list it.

````

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