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

# Get My Profile

> Retrieve current authenticated user



## OpenAPI

````yaml /api-reference/swagger.yml get /v2/me
openapi: 3.0.0
info:
  version: 1.0.0
  title: Prisme.ai APIs
  description: Prisme.ai APIs specifications
  termsOfService: https://www.prisme.ai/mentions-legales
  contact:
    name: Prisme.ai Support Team
    email: support@prisme.ai
    url: https://www.prisme.ai
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.studio.prisme.ai
    description: Prisme.ai Cloud
  - url: https://{customDomain}
    description: Self-hosted Prisme.ai instance
    variables:
      customDomain:
        default: api.your-prisme-instance.com
        description: API hostname of your self-hosted Prisme.ai deployment
  - url: http://localhost:3001
    description: Local development
security:
  - BearerAuth: []
  - OrgApiKeyAuth: []
  - BearerAuth: []
    OrgApiKeyAuth: []
tags:
  - name: API Gateway
    description: >-
      Authentication, session management, SSO providers, and user profile
      endpoints.
  - name: Prisme.ai Workspaces
    description: >-
      CRUD operations for workspaces and their resources (pages, apps,
      automations, imports, variables).
  - name: Prisme.ai Runtime
    description: Execute workspace automations and manage their runtime lifecycle.
  - name: Prisme.ai Events
    description: Event ingestion, delivery, and subscription filtering across the platform.
  - name: Organizations
    description: >-
      Manage organizations, members, roles, invites, groups, and org-level
      service accounts.
  - name: Subscriptions
    description: >-
      Manage organization subscription plans and tier assignments (SuperAdmin
      only).
  - name: Secrets
    description: Read and patch encrypted key-value secrets scoped to a workspace.
  - name: ApiKeys
    description: Create, list, rotate, and validate workspace-scoped API keys.
  - name: Permissions
    description: >-
      Share or unshare resources (workspaces, pages, …) with users via roles or
      fine-grained rules.
  - name: Monitoring
    description: Platform readiness checks across services (SuperAdmin only).
  - name: AuthProviders
paths:
  /v2/me:
    get:
      tags:
        - API Gateway
      summary: Get My Profile
      description: Retrieve current authenticated user
      operationId: getMyProfile
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/User'
                  - type: object
                    required:
                      - sessionId
                    properties:
                      sessionId:
                        type: string
                      expires:
                        type: string
                  - $ref: '#/components/schemas/UserOrgDetails'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
components:
  schemas:
    User:
      allOf:
        - type: object
          properties:
            email:
              type: string
              example: foo@prisme.ai
            status:
              type: string
              enum:
                - pending
                - validated
                - deactivated
            language:
              type: string
            authData:
              type: object
              properties:
                anonymous:
                  type: object
                prismeai:
                  type: object
                azure:
                  $ref: '#/components/schemas/AuthData'
              additionalProperties: true
            mfa:
              $ref: '#/components/schemas/SupportedMFA'
            meta:
              type: object
            orgSlugs:
              type: array
              items:
                type: string
            platformRole:
              type: string
            groupAcls:
              type: object
              additionalProperties:
                type: object
                additionalProperties: false
                properties:
                  role:
                    type: string
            createdAt:
              type: string
            updatedAt:
              type: string
            updatedBy:
              type: string
        - $ref: '#/components/schemas/Contact'
    UserOrgDetails:
      type: object
      properties:
        org:
          type: object
          nullable: true
          properties:
            slug:
              type: string
            name:
              type: string
            status:
              type: string
            branding:
              type: object
              additionalProperties: true
            navigation:
              $ref: '#/components/schemas/Navigation'
            role:
              type: object
              properties:
                slug:
                  type: string
                name:
                  type: string
                permissions:
                  type: array
                  items:
                    type: string
                scopes:
                  type: array
                  items:
                    type: string
            groups:
              type: array
              items:
                type: string
            settings:
              type: object
              additionalProperties: true
            subscription:
              $ref: '#/components/schemas/OrgSubscription'
        permissions:
          type: array
          items:
            type: string
        organizations:
          type: array
          items:
            type: object
            properties:
              slug:
                type: string
              name:
                type: string
              roleSlug:
                type: string
              groups:
                type: array
                items:
                  type: string
    AuthenticationError:
      type: object
      properties:
        error:
          type: string
          example: AuthenticationError
        message:
          type: string
          example: Unauthenticated
    AuthData:
      type: object
      required:
        - id
      additionalProperties: true
      properties:
        id:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        language: {}
    SupportedMFA:
      type: string
      enum:
        - totp
        - none
        - '*'
    Contact:
      allOf:
        - required:
            - firstName
          type: object
          properties:
            firstName:
              type: string
              description: Name
            lastName:
              type: string
              description: Name
            language:
              type: string
            photo:
              type: string
              description: Profile picture URL
            status:
              type: string
              enum:
                - pending
                - validated
                - deactivated
            meta:
              type: object
            groups:
              type: array
              items:
                type: string
            membership:
              type: object
              description: >-
                Organization membership info (only returned when
                includeOrgMembership is set)
              properties:
                roleSlug:
                  type: string
                status:
                  type: string
                  enum:
                    - active
                    - invited
                    - suspended
                joinedAt:
                  type: string
                joinedVia:
                  type: string
                  enum:
                    - direct
                    - invite-code
                    - invite-email
                    - auto-join
                    - join-rule
                invitedAt:
                  type: string
                invitedBy:
                  type: string
        - $ref: '#/components/schemas/Object'
    Navigation:
      type: object
      description: Organization navigation configuration
      properties:
        version:
          type: integer
          description: Schema version number
        homePage:
          type: string
          description: >-
            Route to use as home page (e.g., "/apps/agent-factory"). Must be a
            valid relative path starting with /. If not set, defaults to the
            platform default (SecureChat).
          pattern: ^\/[a-zA-Z0-9\-_\/]*$
        menu:
          type: array
          description: Main menu items
          items:
            $ref: '#/components/schemas/NavigationItem'
        footer:
          type: array
          description: Footer menu items
          items:
            $ref: '#/components/schemas/NavigationItem'
        quickActions:
          type: array
          description: Quick action buttons
          items:
            $ref: '#/components/schemas/NavigationItem'
    OrgSubscription:
      type: object
      required:
        - slug
        - name
        - tier
        - status
      properties:
        id:
          type: string
        slug:
          type: string
        name:
          type: string
        tier:
          type: string
        plan:
          type: string
        status:
          type: string
          enum:
            - active
            - inactive
            - trialing
            - past_due
            - canceled
        isDefault:
          type: boolean
        limits:
          type: object
          additionalProperties: true
        features:
          type: object
          additionalProperties: true
        billing:
          type: object
          additionalProperties: true
        startedAt:
          type: string
        expiresAt:
          type: string
        createdBy:
          type: string
        updatedBy:
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string
    Object:
      type: object
      properties:
        id:
          type: string
          description: Unique id
    NavigationItem:
      type: object
      description: Menu item in the navigation structure
      required:
        - id
        - type
      properties:
        id:
          type: string
          description: Unique identifier for this menu item
        type:
          type: string
          enum:
            - category
            - item
            - divider
        label:
          type: string
          description: Display label (not required for dividers)
        icon:
          type: string
          description: Icon name (from lucide-react)
        color:
          type: string
          description: Icon color (CSS color value)
        href:
          type: string
          description: Link destination (for type=item)
        target:
          type: string
          enum:
            - _self
            - _blank
          description: Link target
        expanded:
          type: boolean
          description: Whether category is expanded by default
        badge:
          type: string
          description: Badge text to show (e.g., "New", "Beta")
        permissions:
          type: array
          description: Permissions required to see this item
          items:
            type: string
        features:
          type: array
          description: Features attached to this item
          items:
            $ref: '#/components/schemas/NavigationFeature'
        visibility:
          type: object
          description: Visibility rules for subscription tiers/features
          properties:
            tiers:
              type: array
              items:
                type: string
            features:
              type: array
              items:
                type: string
        items:
          type: array
          description: Child items (for type=category)
          items:
            type: object
            description: >-
              Recursive reference to `NavigationItem` — nesting is truncated
              here to avoid the infinite expansion that crashes the API
              reference renderer.
      example:
        id: workspaces
        type: category
        label: Workspaces
        icon: folder
        expanded: true
        items:
          - id: workspaces-list
            type: item
            label: All workspaces
            href: /workspaces
          - id: workspaces-create
            type: item
            label: Create workspace
            href: /workspaces/new
    NavigationFeature:
      type: object
      description: Feature attached to a navigation item (agent or template)
      required:
        - type
        - slug
        - label
      properties:
        type:
          type: string
          enum:
            - agent
            - template
        slug:
          type: string
          description: Unique identifier for this feature within the menu item
        label:
          type: string
          description: Display label for the feature
        agentId:
          type: string
          description: Agent ID (required when type=agent)
        templateId:
          type: string
          description: Template ID (required when type=template)
        permissions:
          type: array
          description: Permissions required to see this feature
          items:
            type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    OrgApiKeyAuth:
      type: apiKey
      in: header
      name: x-prismeai-api-key

````