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

> Returns the user's account, patient info, and billing status.



## OpenAPI

````yaml api-reference/openapi.yaml GET /api/profile
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

    Care is licensed by where the patient is physically located when they
    request it, so every conversation carries an ISO 3166-2 `region` code.
    Arlo currently serves California, United States (`US-CA`); an unsupported
    region is refused with `REGION_NOT_SUPPORTED`, whose payload names the
    regions Arlo serves at that moment.
  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/profile:
    get:
      tags:
        - Profile
      summary: Get user profile
      description: Returns the user's account, patient info, and billing status.
      operationId: getProfile
      responses:
        '200':
          description: User profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfile'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    UserProfile:
      type: object
      description: User account and patient profile
      properties:
        account:
          type: object
          properties:
            accountId:
              type: string
            status:
              type: string
        patients:
          type: array
          items:
            $ref: '#/components/schemas/PatientInfo'
        billing:
          $ref: '#/components/schemas/SubscriptionInfo'
    PatientInfo:
      type: object
      description: Patient profile information
      properties:
        patientId:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        displayName:
          type: string
        gender:
          type: string
          enum:
            - Female
            - Male
            - Other
        phone:
          type: string
        email:
          type: string
          format: email
        birthDate:
          type: object
          properties:
            year:
              type: integer
            month:
              type: integer
            day:
              type: integer
        isDefault:
          type: boolean
        address:
          type: string
        city:
          type: string
        province:
          type: string
          description: |
            State code of the patient's home address (e.g. CA, NY); Canadian
            province codes are accepted for legacy CA accounts. This is not the
            care region — that is the conversation's ISO 3166-2 region.
        country:
          type: string
          enum:
            - CA
            - US
        zip:
          type: string
        healthNumber:
          type: string
        medications:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
              description:
                type: string
        conditions:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
              description:
                type: string
        allergies:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
              severity:
                type: string
    SubscriptionInfo:
      type: object
      description: >-
        User payment status and pay-per-use option(s). (Schema name retained for
        compatibility; Arlo is pay-per-use, not subscription-based.)
      properties:
        billingMode:
          type: string
          enum:
            - NONE
            - PAY_AS_YOU_GO
            - SUBSCRIPTION
            - LEGACY
        paymentStatus:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - FAILED
            - CANCELLED
            - ACTIVE_UNTIL_EXPIRY
        freeTrialActive:
          type: boolean
        freeTrialEndTimestamp:
          type: integer
          description: Unix timestamp
        nextBillingTimestamp:
          type: integer
          description: Unix timestamp
        nextBillingAmount:
          type: integer
          description: Amount in cents
        paymentOptions:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              title:
                type: string
              price:
                type: string
              description:
                type: string
              priceAmountCents:
                type: integer
              isDefault:
                type: boolean
              billingMode:
                type: string
              interval:
                type: string
  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

````