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

# List profiles

> Self-scoped.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/users/profile/
openapi: 3.0.3
info:
  title: Hi-Doctor API
  version: 1.0.0
  description: >-
    Patient-facing REST API for Hi-Doctor.


    Authenticate with email and password to receive a JWT pair, then send the
    access token as `Authorization: Bearer <token>` on every subsequent request.


    Only patient-accessible endpoints are documented here. Clinician and
    back-office endpoints are intentionally omitted.
  contact:
    name: Hi-Doctor
    email: hello@hi-doctor.ai
    url: https://hi-doctor.ai
servers:
  - url: https://api.hi-doctor.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Registration, email verification, sign-in and profile.
  - name: Questionnaires
    description: Complete a consultation questionnaire and submit it for medical review.
  - name: Consultations
    description: Consultations a doctor has reviewed or is reviewing.
  - name: Prescriptions
    description: Prescriptions and reissue requests.
  - name: Billing
    description: Checkout, subscription management and the Stripe billing portal.
  - name: Records
    description: Orders, invoices and side-effect reports.
  - name: Messages
    description: The patient's private thread with their medical team.
  - name: Progress
    description: Weight, injection and note tracking. Requires an active treatment plan.
  - name: Referrals
    description: Referral summary and transactions.
paths:
  /v1/users/profile/:
    get:
      tags:
        - Account
      summary: List profiles
      description: Self-scoped.
      operationId: users_profile_retrieve
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfile'
              example:
                id: 0a1b2c3d-4e5f-4a6b-8c9d-000000000001
                email: patient@example.com
                first_name: Alex
                last_name: Moreno
                date_of_birth: '1985-04-12'
                gender: '1'
                country_of_residence: ESP
                timezone: Europe/Madrid
                locale: en
                city: null
                postal_code: null
                issuing_state: ESP
                document_number: X0000000X
                document_type: ID_CARD
                addresses: []
                is_doctor: false
                is_backoffice_admin: false
                is_marketer: false
                is_referrer: false
                forms_completed:
                  hair_growth: true
                  weight_loss: true
                  sexual_health: false
                  premature_ejaculation: false
                  chlamydia: false
                  urinary_tract_infection: false
                  emergency_contraception: false
                  hiv_prep: false
          description: ''
        '401':
          description: >-
            No bearer token, or a token that is expired or malformed.
            Re-authenticate; do not retry the same token.
          content:
            application/json:
              example:
                detail: Given token not valid for any token type
                code: token_not_valid
                messages:
                  - token_class: AccessToken
                    token_type: access
                    message: Token is invalid
      security:
        - jwtAuth: []
components:
  schemas:
    UserProfile:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        email:
          type: string
          readOnly: true
        first_name:
          type: string
          maxLength: 150
        last_name:
          type: string
          maxLength: 150
        date_of_birth:
          type: string
          format: date
          nullable: true
        gender:
          allOf:
            - $ref: '#/components/schemas/GenderEnum'
          description: Patient gender is required
        country_of_residence:
          type: string
          nullable: true
        timezone:
          type: string
          maxLength: 64
        locale:
          $ref: '#/components/schemas/LocaleEnum'
        city:
          type: string
          nullable: true
          description: Patient city used to recommend nearby pharmacies.
          maxLength: 120
        postal_code:
          type: string
          nullable: true
          description: Patient postal code used to recommend nearby pharmacies.
          maxLength: 20
        issuing_state:
          type: string
          nullable: true
        document_number:
          type: string
          nullable: true
          maxLength: 50
        document_type:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/DocumentTypeEnum'
            - $ref: '#/components/schemas/BlankEnum'
            - $ref: '#/components/schemas/NullEnum'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/Address'
          readOnly: true
        orders:
          type: array
          items:
            $ref: '#/components/schemas/Order'
          readOnly: true
        is_doctor:
          type: boolean
          readOnly: true
        is_backoffice_admin:
          type: boolean
          readOnly: true
          description: >-
            Can manage configuration surfaces such as questionnaires, templates,
            automations, and audiences.
        is_marketer:
          type: boolean
          readOnly: true
          description: >-
            Can access aggregated revenue and funnel analytics without patient
            or doctor PII.
        is_referrer:
          type: boolean
          readOnly: true
        forms_completed:
          type: object
          additionalProperties: {}
          readOnly: true
      required:
        - addresses
        - email
        - forms_completed
        - gender
        - id
        - is_backoffice_admin
        - is_doctor
        - is_marketer
        - is_referrer
        - orders
    GenderEnum:
      enum:
        - '0'
        - '1'
        - '2'
        - '3'
      type: string
    LocaleEnum:
      enum:
        - de
        - en
        - es
        - fr
        - it
        - nl
        - pt
      type: string
    DocumentTypeEnum:
      enum:
        - PASSPORT
        - ID_CARD
      type: string
    BlankEnum:
      enum:
        - ''
    NullEnum:
      enum:
        - null
    Address:
      type: object
      properties:
        id:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        province:
          type: string
        country:
          type: string
        zip:
          type: string
        phone:
          type: string
      required:
        - address1
        - address2
        - city
        - country
        - firstName
        - id
        - lastName
        - phone
        - province
        - zip
    Order:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        orderNumber:
          type: integer
        processedAt:
          type: string
          format: date-time
        totalPrice:
          type: object
          additionalProperties: {}
        lineItems:
          type: array
          items:
            $ref: '#/components/schemas/OrderLineItem'
      required:
        - id
        - lineItems
        - name
        - orderNumber
        - processedAt
        - totalPrice
    OrderLineItem:
      type: object
      properties:
        title:
          type: string
        quantity:
          type: integer
        variant:
          type: object
          additionalProperties: {}
      required:
        - quantity
        - title
        - variant
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token from POST /v1/users/token/
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````