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

# List appointments

> Paginated list of appointments. Pass `external_id=<value>` to look up a single appointment by caller-supplied external_id (returns 404 if not found).



## OpenAPI

````yaml /openapi/ext-api-v1.json get /appointments
openapi: 3.0.0
info:
  title: Healos External API
  version: 1.0.0
  description: >-
    External API for managing patients, documents, and appointments, listing
    providers, and for pulling clinical notes (with transcript and patient
    context).
servers:
  - url: https://api.healos.ai/ext-api/v1
    description: Production
  - url: http://localhost:8787/ext-api/v1
    description: Local development
security:
  - ApiKeyAuth: []
paths:
  /appointments:
    get:
      tags:
        - Appointments
      summary: List appointments
      description: >-
        Paginated list of appointments. Pass `external_id=<value>` to look up a
        single appointment by caller-supplied external_id (returns 404 if not
        found).
      parameters:
        - schema:
            type: string
            default: '1'
            example: '1'
          required: false
          name: page
          in: query
        - schema:
            type: string
            default: '20'
            example: '20'
          required: false
          name: limit
          in: query
        - schema:
            type: string
            description: Filter by date (YYYY-MM-DD)
            example: '2026-04-15'
          required: false
          name: date
          in: query
        - schema:
            type: string
            description: Filter start date (YYYY-MM-DD)
            example: '2026-04-01'
          required: false
          name: start_date
          in: query
        - schema:
            type: string
            description: Filter end date (YYYY-MM-DD)
            example: '2026-04-30'
          required: false
          name: end_date
          in: query
        - schema:
            type: string
            description: >-
              Look up a single appointment by caller-supplied external_id
              (bypasses pagination).
            example: PARTNER-APPT-789
          required: false
          name: external_id
          in: query
      responses:
        '200':
          description: List of appointments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppointmentListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: external_id lookup miss
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
components:
  schemas:
    AppointmentListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Appointment'
        meta:
          type: object
          properties:
            page:
              type: number
            limit:
              type: number
            total_pages:
              type: number
          required:
            - page
            - limit
            - total_pages
      required:
        - data
        - meta
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
    RateLimitError:
      type: object
      properties:
        error:
          type: string
          example: Rate limit exceeded. Please retry after the window resets.
      required:
        - error
    Appointment:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: f47ac10b-58cc-4372-a567-0e02b2c3d479
        patient_id:
          type: string
          description: Patient ID
          example: '1743552000000'
        patient_name:
          type: string
          example: Maria Santos
        provider_id:
          type: string
          nullable: true
          description: >-
            Internal id of the provider this appointment belongs to (see GET
            /providers).
          example: aaaaaaa1-0000-0000-0000-000000000001
        provider_name:
          type: string
          nullable: true
          description: Provider display name
          example: Dr. Alice Nguyen
        provider_npi:
          type: string
          nullable: true
          description: Provider's individual (type-I) NPI, when recorded.
          example: '1234567890'
        appointment_type:
          type: string
          example: Initial Evaluation
        visit_type:
          type: string
          enum:
            - Telehealth
            - In-Person
            - Both
            - Other
          example: Telehealth
        start_at:
          type: string
          description: ISO 8601 datetime
          example: '2026-04-15T14:00:00.000Z'
        duration_minutes:
          type: number
          example: 50
        notes:
          type: string
          nullable: true
          example: New patient intake. Please complete forms beforehand.
        status:
          type: string
          enum:
            - SCHEDULED
            - COMPLETED
            - CANCELLED
            - NO_SHOW
          example: SCHEDULED
        created_at:
          type: string
          description: ISO 8601 datetime
          example: '2026-04-01T10:00:00.000Z'
        updated_at:
          type: string
          description: ISO 8601 datetime
          example: '2026-04-01T10:00:00.000Z'
        repeat_rule:
          $ref: '#/components/schemas/RepeatRule'
        external_id:
          type: string
          nullable: true
          description: Caller-supplied external identifier (immutable once set)
          example: PARTNER-APPT-789
      required:
        - id
        - patient_id
        - patient_name
        - provider_id
        - provider_name
        - provider_npi
        - appointment_type
        - visit_type
        - start_at
        - duration_minutes
        - notes
        - status
        - created_at
        - updated_at
        - repeat_rule
        - external_id
    RepeatRule:
      type: object
      nullable: true
      properties:
        frequency:
          type: string
          example: WEEKLY
        interval:
          type: number
          example: 1
        end_date:
          type: string
          nullable: true
          example: '2026-07-15'
      required:
        - frequency
        - interval
        - end_date
      description: Recurrence rule, if any
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key obtained from /api/v1/ext-api-keys

````