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

# getUserProfile

> Returns a user profile with privacy-controlled access to organization information. Organization details (orgId, orgRole) are only included if the requesting user is in the same organization or has admin privileges. Returns null if the user does not exist. Requires authentication.



## OpenAPI

````yaml api-reference/convex-openapi.yaml post /api/run/users/queries/getUserProfile
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/getUserProfile:
    post:
      tags:
        - Users
      summary: getUserProfile
      description: >-
        Returns a user profile with privacy-controlled access to organization
        information. Organization details (orgId, orgRole) are only included if
        the requesting user is in the same organization or has admin privileges.
        Returns null if the user does not exist. Requires authentication.
      operationId: postApiRunUsersQueriesGetUserProfile
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Request_users.queries.getUserProfile'
            example:
              args:
                userId: user_9f3c2ab457
        required: true
      responses:
        '200':
          description: Convex executed your request and returned a result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response_users.queries.getUserProfile'
              example:
                status: success
                errorMessage: ''
                errorData: {}
                value:
                  _id: user_9f3c2ab457
                  displayName: Member Example
                  avatarUrl: https://example.com/avatar.jpg
                  isActive: true
                  orgId: org_abc123
                  orgRole: member
        '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.getUserProfile:
      type: object
      required:
        - args
      properties:
        args:
          type: object
          required:
            - userId
          properties:
            userId:
              type: string
              description: ID from table "users"
    Response_users.queries.getUserProfile:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - success
            - error
        errorMessage:
          type: string
        errorData:
          type: object
        value:
          type: object
          required:
            - _id
            - isActive
          properties:
            _id:
              type: string
              description: ID from table "users"
            avatarUrl:
              type: string
            displayName:
              type: string
            isActive:
              type: boolean
            orgId:
              type: string
            orgRole:
              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>`.

````