> ## Documentation Index > Fetch the complete documentation index at: https://docs.lighton.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get current user profile > Returns information on the authenticated user. ## OpenAPI ````yaml /api-reference/openapi-v3.yaml get /api/v3/users/me openapi: 3.1.0 info: title: LightOn API version: 3.15.0 (v3) description: >- LightOn gives you an API to search, parse, and ingest documents at scale. Build knowledge-retrieval pipelines without managing vector databases or OCR models. servers: - url: https://paradigm.lighton.ai security: [] tags: - name: Agents description: Operations about agents - name: Threads description: Operations about agents conversation threads - name: Tools description: Operations about native tools - name: Models description: Operations about AI models - name: MCP description: Operations about MCP servers - name: Sources description: Operations about sources used by agents conversation threads - name: Artifacts description: Operations about artifacts generated by agents conversation threads - name: Agent description: >- Operations about agents (deprecated). Please use the 'Agents' API component instead. - name: Files description: Operations about files - name: Facets description: Operations about facets - name: Tags description: Operations about tags - name: Workspaces description: Operations about workspaces - name: Files Processing description: Operations about files processing - name: Users description: Operations about users - name: API Keys description: Operations about API keys - name: User Groups description: Operations about user groups - name: SCIM description: Operations about SCIM paths: /api/v3/users/me: get: tags: - Users summary: Get current user profile description: Returns information on the authenticated user. operationId: api_v3_users_me_retrieve responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserInfo' description: Current user profile '401': content: application/json: schema: $ref: '#/components/schemas/APIV3ErrorResponse' examples: Unauthorized: value: id: null code: 401 error: unauthorized detail: >- Authentication credentials were not provided or are invalid. doc_url: https://developers.lighton.ai/errors#unauthorized description: Authentication credentials were not provided or are invalid '503': description: >- API is under maintenance. Check `GET /api/v3/system/status` for active periods and retry. content: application/json: schema: $ref: '#/components/schemas/ServiceMaintenance503' security: - bearerAuth: [] components: schemas: UserInfo: type: object description: Everything about the currently authenticated user. properties: has_usable_password: type: boolean description: Whether the user has a password set (false for SSO/LDAP-only). email_verified: type: boolean description: Whether the user's primary email has been verified. roles: type: array items: type: string description: The user's role slugs, e.g. `company_admin`. persona: description: |- What the user is trying to achieve, captured at onboarding. * `integrate` - integrate * `no_code` - no_code * `evaluate` - evaluate * `exploring` - exploring oneOf: - $ref: '#/components/schemas/UserInfoPersonaEnum' - $ref: '#/components/schemas/NullEnum' channel: description: |- How the user will mostly interact, captured at onboarding. * `api` - api * `mcp` - mcp oneOf: - $ref: '#/components/schemas/UserInfoChannelEnum' - $ref: '#/components/schemas/NullEnum' profile: allOf: - $ref: '#/components/schemas/UserInfoProfile' description: The user's identity. company: oneOf: - $ref: '#/components/schemas/UserInfoCompany' - type: 'null' description: The user's company. Null if the user has no company. permissions: allOf: - $ref: '#/components/schemas/UserInfoPermissions' description: What the user is allowed to do. settings: allOf: - $ref: '#/components/schemas/UserInfoSettings' description: The user's preferences. compliance: allOf: - $ref: '#/components/schemas/UserInfoCompliance' description: The user's legal acceptance status. group_memberships: type: array items: $ref: '#/components/schemas/UserInfoGroupMembership' description: The groups the user belongs to, with their role in each. required: - channel - company - compliance - email_verified - group_memberships - has_usable_password - permissions - persona - profile - roles - settings APIV3ErrorResponse: type: object properties: id: type: - string - 'null' description: >- Job/resource id when one already exists (useful for async error diagnosis); null otherwise. code: type: integer description: HTTP status code error: type: string description: Error code used by the UI as a translation key detail: type: string description: Human-readable error message for developers doc_url: type: string description: Link to the error-code documentation page required: - code - detail - doc_url - error - id ServiceMaintenance503: type: object description: >- Returned by the maintenance middleware when the requested endpoint is blocked. required: - detail - error - mode properties: detail: type: string example: System is under maintenance. error: type: string example: service_maintenance mode: type: string enum: - full_shutdown - warning_banner description: >- `full_shutdown` blocks all traffic; `warning_banner` also blocks and shows a dismissible toast. reason: type: string description: Operator-supplied maintenance reason, if any. started_at: type: string format: date-time endpoint_category_names: type: array items: type: string description: >- Non-empty only for category-scoped periods. Empty means all endpoints are affected. UserInfoPersonaEnum: enum: - integrate - no_code - evaluate - exploring type: string description: |- * `integrate` - integrate * `no_code` - no_code * `evaluate` - evaluate * `exploring` - exploring NullEnum: type: 'null' UserInfoChannelEnum: enum: - api - mcp type: string description: |- * `api` - api * `mcp` - mcp UserInfoProfile: type: object description: Who the user is. properties: id: type: - integer - 'null' description: The user ID. Null for a user that has not been saved yet. username: type: string description: The username. first_name: type: string description: The user's first name. last_name: type: string description: The user's last name. email: type: - string - 'null' description: The user's primary email address. display: type: string description: The user's display name. required: - display - email - first_name - id - last_name - username UserInfoCompany: type: object description: The company the user belongs to. properties: id: type: integer description: The company ID. name: type: string description: The company name. tier: allOf: - $ref: '#/components/schemas/TierEnum' description: |- The company commercial tier. * `free` - free * `pay-as-you-go` - pay-as-you-go * `business` - business created_at: type: - string - 'null' format: date-time description: When the company was created. updated_at: type: - string - 'null' format: date-time description: When the company was last updated. login_method: allOf: - $ref: '#/components/schemas/LoginMethodEnum' description: |- How members of the company authenticate. * `password` - password * `sso` - sso * `ldap` - ldap ldap_logout_url: type: - string - 'null' description: LDAP single-logout URL. Null unless the company logs in via LDAP. group: oneOf: - $ref: '#/components/schemas/UserInfoGroup' - type: 'null' description: >- The company-wide group every member belongs to. Null if it has not been created. required: - created_at - group - id - ldap_logout_url - login_method - name - tier - updated_at UserInfoPermissions: type: object properties: is_admin: type: boolean description: Whether the user can access the admin panel. can_manage_documents: type: boolean description: Whether the user can create documents via the API. can_manage_api_keys: type: boolean description: Whether the user can generate their own API keys. has_monitoring_permission: type: boolean description: Whether the user can access monitoring features. required: - can_manage_api_keys - can_manage_documents - has_monitoring_permission - is_admin UserInfoSettings: type: object properties: language: type: string description: The user's preferred language. agent_instructions: type: - string - 'null' description: Custom instructions applied to the user's agent runs. skip_help_step: type: boolean description: Whether the user opted out of the UI help step. required: - agent_instructions - language - skip_help_step UserInfoCompliance: type: object properties: terms_accepted: type: boolean description: Whether the user accepted the latest terms and conditions. required: - terms_accepted UserInfoGroupMembership: type: object properties: group: allOf: - $ref: '#/components/schemas/UserInfoGroupInfo' description: The group the user belongs to. role: allOf: - $ref: '#/components/schemas/GroupMemberRoleEnum' description: |- The user's role in the group. * `owner` - owner * `member` - member required: - group - role TierEnum: enum: - free - pay-as-you-go - business type: string description: |- * `free` - free * `pay-as-you-go` - pay-as-you-go * `business` - business LoginMethodEnum: enum: - password - sso - ldap type: string description: |- * `password` - password * `sso` - sso * `ldap` - ldap UserInfoGroup: type: object description: A reference to a group. properties: id: type: integer description: The group ID. name: type: string description: The group name. required: - id - name UserInfoGroupInfo: type: object description: A reference to a group, with its category. properties: id: type: integer description: The group ID. name: type: string description: The group name. category: allOf: - $ref: '#/components/schemas/CategoryEnum' description: |- The group category. * `company` - company * `private` - private * `custom` - custom required: - category - id - name GroupMemberRoleEnum: enum: - owner - member type: string description: |- * `owner` - owner * `member` - member CategoryEnum: enum: - company - private - custom type: string description: |- * `company` - company * `private` - private * `custom` - custom securitySchemes: bearerAuth: type: http scheme: bearer description: >- Bearer authentication header of the form `Bearer `, where `` is your auth token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.