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

# Get Current User Profile

> Retrieve comprehensive profile information for the currently authenticated user, including personal details, contact information, and account status.



## OpenAPI

````yaml https://external-api.mileiq.com/openapi.json get /v1/users/me
openapi: 3.1.0
info:
  title: MileIQ External API
  description: External API for integrating with the MileIQ Platform.
  termsOfService: https://mileiq.com/terms
  contact:
    name: MileIQ
    url: https://developer.mileiq.com/
    email: support@mileiq.com
  version: 1.4.0
servers:
  - url: https://external-api.mileiq.com
    description: MileIQ External API
security: []
paths:
  /v1/users/me:
    get:
      tags:
        - users
      summary: Get Current User Profile
      description: >-
        Retrieve comprehensive profile information for the currently
        authenticated user, including personal details, contact information, and
        account status.
      operationId: get_me
      parameters:
        - name: Authorization
          in: header
          required: false
          schema:
            type: string
            title: Authorization
      responses:
        '200':
          description: >-
            Successfully retrieved current user profile. Returns detailed user
            information including name, email addresses, username, and account
            status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSchema'
        '401':
          description: Authentication failed. Invalid or missing authorization token.
        '403':
          description: >-
            Insufficient permissions. User does not have the required
            'users_read' scope or is not authenticated.
        '404':
          description: >-
            User not found. The authenticated user profile could not be located
            in the system.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded. Maximum 30 requests per minute allowed.
        '500':
          description: >-
            Internal server error. An unexpected error occurred while processing
            the request.
components:
  schemas:
    UserSchema:
      properties:
        id:
          type: string
          title: Id
          description: >-
            Unique identifier for the user (Parse ID) - used for API operations
            and internal references
        userName:
          type: string
          title: Username
          description: >-
            User's login username, typically their email address used for
            authentication
        name:
          $ref: '#/components/schemas/Name'
          description: >-
            Structured name information including first name, last name, and
            formatted display name
        emails:
          items:
            $ref: '#/components/schemas/Email'
          type: array
          title: Emails
          description: >-
            Collection of email addresses associated with the user, including
            primary/secondary designation and type classification
        active:
          type: boolean
          title: Active
          description: >-
            Account status flag indicating whether the user account is currently
            active and operational
          default: true
        displayName:
          anyOf:
            - type: string
            - type: 'null'
          title: Displayname
          description: >-
            Formatted display name used throughout the application interface for
            user identification
      type: object
      required:
        - id
        - userName
        - name
        - emails
      title: UserSchema
      description: >-
        Complete user profile information including identity, contact details,
        and account status
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Name:
      properties:
        givenName:
          type: string
          title: Givenname
          description: User's first name (given name) as recorded in their profile
        familyName:
          type: string
          title: Familyname
          description: User's last name (family name/surname) as recorded in their profile
        formatted:
          anyOf:
            - type: string
            - type: 'null'
          title: Formatted
          description: >-
            Full name formatted for display purposes, combining first and last
            names in a readable format
      type: object
      required:
        - givenName
        - familyName
      title: Name
      description: >-
        Complete name information for a user including both individual
        components and formatted display
    Email:
      properties:
        value:
          type: string
          title: Value
          description: >-
            The actual email address in standard email format (e.g.,
            user@example.com)
        type:
          type: string
          title: Type
          description: >-
            Classification of the email address - typically 'work' for business
            emails or 'personal' for private emails
        primary:
          type: boolean
          title: Primary
          description: >-
            Boolean flag indicating whether this is the user's primary/default
            email address for communications
          default: true
      type: object
      required:
        - value
        - type
      title: Email
      description: Email address information with classification and priority designation
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````