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

# List organization phone numbers

> Returns the phone numbers assigned to the organization. Supports filtering by type (payers, patients, unassigned). Requires read:phone_numbers scope.



## OpenAPI

````yaml /openapi-v4.json get /phone-numbers
openapi: 3.0.0
info:
  title: Max AI Public API
  description: API for third-party marketplace apps
  version: '4.0'
  contact: {}
servers:
  - url: https://api.maxcare.ai/v4
security: []
tags: []
paths:
  /phone-numbers:
    get:
      tags:
        - Phone Numbers
      summary: List organization phone numbers
      description: >-
        Returns the phone numbers assigned to the organization. Supports
        filtering by type (payers, patients, unassigned). Requires
        read:phone_numbers scope.
      operationId: PhoneNumbersPublicController_listPhoneNumbers
      parameters:
        - name: type
          required: false
          in: query
          description: Filter by phone number type
          schema:
            enum:
              - unassigned
              - payers
              - patients
            type: string
        - name: X-Organization-Id
          in: header
          required: true
          schema:
            type: string
          description: Target clinic organization ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPhoneNumbersSuccessResponse'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiUnauthorizedResponse'
        '403':
          description: Insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiForbiddenResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiRateLimitResponse'
      security:
        - api-key: []
components:
  schemas:
    ListPhoneNumbersSuccessResponse:
      type: object
      properties:
        code:
          type: string
          description: Response code
          example: success
        data:
          $ref: '#/components/schemas/ListPhoneNumbersResponseData'
      required:
        - code
        - data
    PublicApiUnauthorizedResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: unauthorized
        message:
          type: string
          description: Human-readable error message
          example: Invalid or missing API key
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    PublicApiForbiddenResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: forbidden
        message:
          type: string
          description: Human-readable error message
          example: Insufficient scope
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    PublicApiRateLimitResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: rate_limit_exceeded
        message:
          type: string
          description: Human-readable error message
          example: Rate limit exceeded. Maximum 1000 requests per 60 seconds.
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    ListPhoneNumbersResponseData:
      type: object
      properties:
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/ExternalPhoneNumberResponse'
      required:
        - phoneNumbers
    ExternalPhoneNumberResponse:
      type: object
      properties:
        id:
          type: string
          description: Phone number ID (Quo native ID)
          example: PNxxxxxx
        number:
          type: string
          description: Phone number in E.164 format
          example: '+15551234567'
        formattedNumber:
          type: string
          description: Formatted phone number for display
          nullable: true
          example: (555) 123-4567
        name:
          type: string
          description: Display name
          nullable: true
          example: Main Line
        type:
          type: string
          description: Phone number purpose/type
          enum:
            - unassigned
            - payers
            - patients
          example: patients
      required:
        - id
        - number
        - formattedNumber
        - name
        - type
  securitySchemes:
    api-key:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Marketplace API key

````