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

# Get consultation status and messages

> Returns the current status, messages, and payment gate info for a consultation.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/consultations/{id}
openapi: 3.1.0
info:
  title: Arlo Health MCP Server
  version: 1.0.0
  description: >
    Healthcare infrastructure for AI agents. Everything an agent needs

    to act in healthcare for its user.


    ## Overview


    This server exposes two interfaces:

    - **MCP** (Model Context Protocol) over streamable HTTP at `/` for AI agents

    - **REST API** at `/api/*` for bots, skills, and direct HTTP clients


    Both interfaces use the same tool handlers and authentication.


    ## Authentication


    OAuth 2.1 with PKCE. All `/api/*` endpoints require a Bearer token.


    Discovery endpoints (no auth required):

    - `/.well-known/oauth-protected-resource`

    - `/.well-known/oauth-authorization-server`

    - `/.well-known/mcp.json` (MCP Server Card)


    ## Service Regions


    Available in Ontario, Canada (`CA-ON`) and California, United States
    (`US-CA`).
  contact:
    name: Arlo Health
    url: https://arlohealth.ai
  license:
    name: Proprietary
    url: https://arlohealth.ai/tos
servers:
  - url: https://mcp.arlohealth.ai
    description: Production MCP Server
security:
  - oauth2:
      - openid
      - profile
      - email
      - offline_access
tags:
  - name: Discovery
    description: MCP and OAuth discovery endpoints (no auth required)
  - name: Profile
    description: User profile and patient information
  - name: Consultations
    description: Healthcare consultation management
  - name: Messaging
    description: Conversation messaging and media
  - name: Prescriptions
    description: Prescription and pharmacy management
  - name: Payment
    description: Billing and pay-per-use payment management
  - name: Webhooks
    description: Webhook registration and status
paths:
  /api/consultations/{id}:
    get:
      tags:
        - Consultations
      summary: Get consultation status and messages
      description: >-
        Returns the current status, messages, and payment gate info for a
        consultation.
      operationId: getConsultation
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Consultation/conversation ID
        - name: includeMessages
          in: query
          schema:
            type: boolean
            default: true
          description: Whether to include message history
      responses:
        '200':
          description: Consultation details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsultationDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ConsultationDetail:
      type: object
      description: Full conversation details with messages
      properties:
        conversationId:
          type: string
        status:
          $ref: '#/components/schemas/ConsultationStatus'
        statusDescription:
          type: string
        region:
          type: string
          nullable: true
          description: ISO 3166-2 region this conversation is licensed for
        providerVisit:
          type: object
          nullable: true
          description: Present when a provider is in seat
          properties:
            active:
              type: boolean
            providerName:
              type: string
            consultId:
              type: string
        pastVisits:
          type: array
          description: Prior provider visits on this conversation
          items:
            type: object
            properties:
              consultId:
                type: string
              closedAt:
                type: string
              hasNotes:
                type: boolean
        messages:
          type: array
          description: |
            Windowed to the newest messages by default to keep long threads
            manageable; omittedOlderMessages reports how many older messages
            exist beyond the window.
          items:
            $ref: '#/components/schemas/Message'
        omittedOlderMessages:
          type: integer
          description: Present when the message window truncated older messages
        paymentGate:
          $ref: '#/components/schemas/PaymentGate'
        nextSteps:
          type: array
          items:
            type: string
          description: Suggested actions based on current status
    ConsultationStatus:
      type: string
      enum:
        - IDLE
        - TRIAGING
        - PAYMENT_REQUIRED
        - MATCHING
        - WITH_PROVIDER
        - EMERGENCY
      description: >
        A conversation is a continuous thread — it never "closes." There is no

        terminal CLOSED/CANCELED status: a finished or canceled request simply

        leaves the conversation IDLE with its visit history intact.


        - IDLE: AI-only, nothing in progress. Re-engageable — sending a message
        re-runs triage

        - TRIAGING: AI is gathering symptom information on a live request

        - PAYMENT_REQUIRED: Triage complete, awaiting payment confirmation (or
        dismissal)

        - MATCHING: Being matched with a healthcare provider

        - WITH_PROVIDER: A provider is connected (messaging is asynchronous)

        - EMERGENCY: Urgent care advised — user should call 911 (not
        re-engageable)
    Message:
      type: object
      description: A message in a consultation
      properties:
        id:
          type: string
        type:
          type: string
          enum:
            - text
            - triage
            - photo
            - video
            - file
            - join
            - prescription
            - lab_request
            - unknown
        content:
          type: string
        sender:
          type: string
          enum:
            - user
            - provider
            - ai
            - system
        timestamp:
          type: string
          format: date-time
        senderId:
          type: string
    PaymentGate:
      type: object
      description: Payment gate information when triage is complete
      properties:
        consultationSummary:
          type: string
          description: Markdown summary of what Arlo can help with
        ctaText:
          type: string
          description: Call-to-action button text
        gateType:
          type: string
          description: >-
            PAY_PER_USE = card on file, confirm to place the hold;
            PAYMENT_SETUP_REQUIRED = no card yet, run create_payment_setup first
          enum:
            - NONE
            - PAYMENT_SETUP_REQUIRED
            - PAY_PER_USE
        isLoading:
          type: boolean
          description: Whether summary is still being generated
        paymentType:
          type: string
          enum:
            - pay_per_use
            - payment_setup_required
  responses:
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              needsAuth:
                type: boolean
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.1 with PKCE
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize
          tokenUrl: /oauth/token
          scopes:
            openid: OpenID Connect
            profile: User profile
            email: Email address
            offline_access: Refresh tokens

````