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

# List the drawer

> The household's documents, by label: kind, person, validity, folder and the names of their fields, never a value. `subject`, `kind` and `folder` filter (`folder=none` is the documents in no folder); `expiringBy` keeps the documents valid until that civil date or earlier, and a document with no validity never matches.



## OpenAPI

````yaml /openapi.json get /v1/documents
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/documents:
    get:
      tags:
        - Documents
      summary: List the drawer
      description: >-
        The household's documents, by label: kind, person, validity, folder and
        the names of their fields, never a value. `subject`, `kind` and `folder`
        filter (`folder=none` is the documents in no folder); `expiringBy` keeps
        the documents valid until that civil date or earlier, and a document
        with no validity never matches.
      parameters:
        - schema:
            type: string
            maxLength: 64
          required: false
          name: subject
          in: query
        - schema:
            type: string
            enum:
              - driver-license
              - passport
              - id-card
              - health-card
              - insurance-policy
              - vehicle-licensing
              - other
          required: false
          name: kind
          in: query
        - schema:
            type: string
            maxLength: 10
          required: false
          name: expiringBy
          in: query
        - schema:
            type: string
            maxLength: 64
          required: false
          name: folder
          in: query
      responses:
        '200':
          description: The documents.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HouseDocument'
        '401':
          description: The session is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: >-
            The document or the folder is not in the caller's household, or was
            removed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainError'
        '422':
          description: The body is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/RequestTimeout'
      security:
        - session: []
        - token: []
components:
  schemas:
    HouseDocument:
      type: object
      properties:
        id:
          type: string
        version:
          type: string
        kind:
          type: string
          enum:
            - driver-license
            - passport
            - id-card
            - health-card
            - insurance-policy
            - vehicle-licensing
            - other
        subjectId:
          type: string
          nullable: true
        label:
          type: string
        validUntil:
          type: string
          nullable: true
        folderId:
          type: string
          nullable: true
        fieldNames:
          type: array
          items:
            type: string
        contentType:
          type: string
          enum:
            - application/pdf
            - image/jpeg
            - image/png
      required:
        - id
        - version
        - kind
        - subjectId
        - label
        - validUntil
        - folderId
        - fieldNames
        - contentType
    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
  responses:
    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.