> ## Documentation Index
> Fetch the complete documentation index at: https://dev.nimbo-x.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List people attached to the current patient token

> Lists the non-deleted people authorized for the patient portal token, newest first. The response includes chat availability; a chat-service connection failure can cause the request to fail.



## OpenAPI

````yaml /openapi/nimbo_patient_portal.yml get /api/v1/patient_portal/people
openapi: 3.1.0
info:
  title: Nimbo patient portal
  version: 1.0.0
  description: >-
    Nimbo API reference. Use the API host and integration access provided by
    Nimbo.
servers:
  - url: https://api.example.test
security: []
tags:
  - name: Patient Portal
  - name: Patient portal authentication
paths:
  /api/v1/patient_portal/people:
    get:
      tags:
        - Patient Portal
      summary: List people attached to the current patient token
      description: >-
        Lists the non-deleted people authorized for the patient portal token,
        newest first. The response includes chat availability; a chat-service
        connection failure can cause the request to fail.
      operationId: listPatientPortalPeople
      responses:
        '200':
          description: >-
            Non-deleted people available to the patient token, newest created
            first.
          content:
            application/json:
              schema:
                type: object
                required:
                  - people
                additionalProperties: false
                properties:
                  people:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - full_name
                        - organization_name
                        - doctor_name
                        - telephone2
                        - rooms
                        - avatar_url_large
                        - born_at
                        - gender
                        - medical_history_config
                      additionalProperties: false
                      properties:
                        id:
                          type: integer
                        full_name:
                          type: string
                          example: Demo Patient
                        organization_name:
                          type:
                            - string
                            - 'null'
                        doctor_name:
                          type: string
                        telephone2:
                          type:
                            - string
                            - 'null'
                        rooms:
                          type: boolean
                          description: >-
                            True only when the person's organization has the
                            shared chat entitlement and Firebase returns a
                            non-null chatrooms node. Missing or deleted nodes
                            and organizations without the entitlement return
                            false.
                        avatar_url_large:
                          type: string
                          description: >-
                            One-hour Paperclip avatar URL, or an empty string
                            when no avatar exists.
                          example: >-
                            https://synthetic-patient-assets.example.test/people/avatars/000/001/001/large/avatar.png
                        born_at:
                          type:
                            - string
                            - 'null'
                          format: date
                        gender:
                          type:
                            - string
                            - 'null'
                        medical_history_config:
                          type:
                            - object
                            - 'null'
                          additionalProperties: true
        '401':
          description: Missing, expired, invalid, or unauthorized patient portal token.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                additionalProperties: false
                properties:
                  error:
                    type: string
              examples:
                unauthorized:
                  value:
                    error: Unauthorized
        '500':
          description: >-
            Firebase could not be reached while resolving chat rooms for an
            entitled patient. The error body is runtime-dependent, matching the
            unhandled transport-failure behavior.
      security:
        - PatientPortalToken: []
components:
  securitySchemes:
    PatientPortalToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Patient portal JWT accepted either as a raw Authorization header value
        or as a Bearer token for client compatibility.

````