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

# getCurrentUser

> Returns the full user document for the currently authenticated user based on their WorkOS identity. Returns null if the user is not authenticated, allowing clients to safely subscribe without triggering errors during logged-out states. This is the primary method for retrieving the current user's data in authenticated contexts.



## OpenAPI

````yaml api-reference/convex-openapi.yaml post /api/run/users/queries/getCurrentUser
openapi: 3.0.3
info:
  title: Connvo Convex API
  version: 1.0.0
  description: >-
    HTTP interface for Connvo's Convex backend, exposing vetted query, mutation,
    and action endpoints.
servers:
  - url: https://Connvo-dev.convex.cloud
    description: Dev Convex deployment
  - url: https://Connvo-staging.convex.cloud
    description: Staging Convex deployment
  - url: https://Connvo-prod.convex.cloud
    description: Prod Convex deployment
security:
  - bearerAuth: []
tags:
  - name: Users
    description: Identity, profile, and authentication operations for Connvo users.
  - name: Meetings
    description: Scheduling, managing, and retrieving meeting data.
  - name: Transcripts
    description: Endpoints for accessing call transcripts and transcription controls.
  - name: Insights
    description: AI-generated insights, summaries, and analytics derived from meetings.
  - name: Prompts
    description: Prompt management and AI conversation guidance.
  - name: Notes
    description: Collaborative meeting notes and follow-up documentation.
  - name: WebRTC
    description: Real-time communication, session signalling, and media utilities.
  - name: System
    description: General system endpoints such as health checks and diagnostics.
paths:
  /api/run/users/queries/getCurrentUser:
    post:
      tags:
        - Users
      summary: getCurrentUser
      description: >-
        Returns the full user document for the currently authenticated user
        based on their WorkOS identity. Returns null if the user is not
        authenticated, allowing clients to safely subscribe without triggering
        errors during logged-out states. This is the primary method for
        retrieving the current user's data in authenticated contexts.
      operationId: postApiRunUsersQueriesGetCurrentUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Request_users.queries.getCurrentUser'
            example:
              args: {}
        required: true
      responses:
        '200':
          description: Convex executed your request and returned a result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response_users.queries.getCurrentUser'
              example:
                status: success
                errorMessage: ''
                errorData: {}
                value:
                  _id: user_9f3c2ab457
                  _creationTime: 1716403200000
                  workosUserId: org_user_123
                  email: member@example.com
                  displayName: Member Example
                  orgId: org_abc123
                  orgRole: member
                  isActive: true
                  onboardingComplete: true
                  onboardingStartedAt: 1716406800000
                  onboardingCompletedAt: 1716489600000
                  createdAt: 1716403200000
                  updatedAt: 1716489600000
        '400':
          description: Failed operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
        '500':
          description: Convex Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    Request_users.queries.getCurrentUser:
      type: object
      required:
        - args
      properties:
        args:
          type: object
    Response_users.queries.getCurrentUser:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - success
            - error
        errorMessage:
          type: string
        errorData:
          type: object
        value:
          type: object
          required:
            - _creationTime
            - _id
            - createdAt
            - email
            - isActive
            - updatedAt
            - workosUserId
          properties:
            _creationTime:
              type: number
            _id:
              type: string
              description: ID from table "users"
            avatarUrl:
              type: string
            createdAt:
              type: number
            displayName:
              type: string
            email:
              type: string
            isActive:
              type: boolean
            lastSeenAt:
              type: number
            onboardingComplete:
              type: boolean
            onboardingCompletedAt:
              type: number
            onboardingStartedAt:
              type: number
            orgId:
              type: string
            orgRole:
              type: string
            updatedAt:
              type: number
            workosUserId:
              type: string
          nullable: true
    FailedResponse:
      type: object
      properties: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Standard user authentication token issued via WorkOS. Provide as
        `Authorization: Bearer <user-token>`.

````