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

> The people of the caller's household: owners, who sign in, and reference people, who are only named.



## OpenAPI

````yaml /openapi.json get /v1/settings/people
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/settings/people:
    get:
      tags:
        - People
      summary: List people
      description: >-
        The people of the caller's household: owners, who sign in, and reference
        people, who are only named.
      responses:
        '200':
          description: The current household people.
          content:
            application/json:
              schema:
                type: object
                properties:
                  people:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        form:
                          type: string
                          enum:
                            - owner
                            - reference
                            - pet
                        name:
                          type: string
                        displayName:
                          type: string
                        kinship:
                          type: string
                          nullable: true
                        phone:
                          type: string
                          nullable: true
                        userId:
                          type: string
                          nullable: true
                        names:
                          type: object
                          properties:
                            id:
                              type: string
                            displayName:
                              type: string
                            nicknames:
                              type: array
                              items:
                                type: string
                          required:
                            - id
                            - displayName
                            - nicknames
                        inviteStatus:
                          type: string
                          nullable: true
                          enum:
                            - pending
                            - used
                            - expired
                            - null
                        profile:
                          $ref: '#/components/schemas/PersonProfile'
                      required:
                        - id
                        - form
                        - name
                        - kinship
                        - phone
                        - userId
                        - names
                        - inviteStatus
                        - profile
                required:
                  - people
        '401':
          description: The session is missing or invalid.
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/RequestTimeout'
      security:
        - session: []
components:
  schemas:
    PersonProfile:
      type: object
      nullable: true
      properties:
        id:
          type: string
        personId:
          type: string
        kinship:
          type: string
          nullable: true
          description: 'Quem é: filha, avó. Never a nickname.'
        birthDate:
          type: string
          nullable: true
          description: YYYY-MM-DD.
        ageYears:
          type: integer
          nullable: true
          description: >-
            Whole years on the read's São Paulo date, derived from `birthDate`;
            never stored.
        caregiverDays:
          type: array
          items:
            type: object
            properties:
              weekday:
                type: string
                enum:
                  - MO
                  - TU
                  - WE
                  - TH
                  - FR
                  - SA
                  - SU
                description: 'RFC 5545: MO, TU, WE, TH, FR, SA, SU.'
              duty:
                type: string
                enum:
                  - take
                  - fetch
                description: '`take` (leva) or `fetch` (busca).'
              subjectId:
                type: string
                nullable: true
                description: >-
                  Whom the role is for, a member of the house; `null` for no
                  one.
            required:
              - weekday
              - duty
              - subjectId
          description: Papel fixo, in the order written.
        source:
          type: string
          enum:
            - onboarding
            - add-person
            - settings
        confidence:
          type: string
        appliedAt:
          type: string
          format: date-time
        supersededBy:
          type: string
          nullable: true
      required:
        - id
        - personId
        - kinship
        - birthDate
        - ageYears
        - caregiverDays
        - source
        - confidence
        - appliedAt
        - supersededBy
      description: The current profile; `null` for a pet, which has none.
    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.

````

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