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

# Get current user

> Get the current authenticated user's profile information including:
- Email and role
- Feature flags (neo_ai access, etc.)
- User tag (if any)
- Team membership (if user belongs to a team)




## OpenAPI

````yaml https://neo.api.projectdiscovery.io/api/openapi.json get /api/v1/user
openapi: 3.1.0
info:
  contact:
    name: ProjectDiscovery
    url: https://neo.projectdiscovery.io
  description: Neo API Server - Security agent orchestration platform
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  title: Neo API
  version: 1.0.0
servers:
  - description: Production
    url: https://neo.api.projectdiscovery.io
  - description: Local development
    url: http://localhost:8080
security: []
tags:
  - description: Task execution and management
    name: Tasks
  - description: Agent listing and management
    name: Agents
  - description: Public agent directory
    name: Agent Directory
  - description: User file storage management
    name: Files
  - description: User working memory management
    name: Memory
  - description: Scheduled and recurring task management
    name: Schedules
  - description: Knowledge base and semantic search
    name: Knowledge
  - description: Encrypted user credentials and API keys
    name: Secrets
  - description: Neo API key management for programmatic access
    name: API Keys
  - description: User profile and account information
    name: User
  - description: Task and LLM usage tracking
    name: Usage
  - description: Bring Your Own Key provider management
    name: BYOK
  - description: Model discovery and capabilities
    name: Models
  - description: Third-party integrations
    name: Integrations
  - description: Skill knowledge documents for agent prompts
    name: Skills
  - description: Team management and member invitations
    name: Teams
  - description: Prompt library management and discovery
    name: Prompts
  - description: Slack bot integration for workspace installation and OAuth
    name: Slack
  - description: GitHub integration for PR reviews and repository management
    name: GitHub
  - description: Vulnerability issue tracking and management
    name: Issues
  - description: Subscription billing and plans
    name: Billing
  - description: Project management and member assignments
    name: Projects
  - description: SSH key pair generation and management for remote server access
    name: SSH Keys
  - description: Codebase structural analysis and mapping
    name: Codemaps
  - description: AI-generated codebase documentation and security analysis
    name: CodeWiki
  - description: Captured HTTP traffic query and replay
    name: Network Events
paths:
  /api/v1/user:
    get:
      tags:
        - User
      summary: Get current user
      description: |
        Get the current authenticated user's profile information including:
        - Email and role
        - Feature flags (neo_ai access, etc.)
        - User tag (if any)
        - Team membership (if user belongs to a team)
      operationId: get-v1-user
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfileResponse'
          description: User profile information
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    UserProfileResponse:
      properties:
        available_models:
          description: >-
            List of canonical Neo model IDs available for the user. In BYOK mode
            this contains only discovered provider models that Neo supports.
          items:
            type: string
          type: array
        byok_models:
          description: >-
            Provider-discovered BYOK models with Neo support classification.
            Returned when the user is in BYOK mode.
          items:
            $ref: '#/components/schemas/ByokDiscoveredModel'
          type: array
        cap:
          allOf:
            - $ref: '#/components/schemas/SpendingCapStatus'
          description: >-
            Caller's own effective spending-cap status
            (source/limit/used/remaining). Null for solo / no-team users or when
            the team isn't on a spend-controls plan. Drives the user's own cap
            banner.
          nullable: true
        egress_ip:
          $ref: '#/components/schemas/EgressIPInfo'
          description: Outbound IP information for customer allowlists
          nullable: true
        email:
          description: User's email address
          format: email
          type: string
        features:
          additionalProperties: {}
          description: >-
            Feature flags for the user (booleans like neo_ai, numbers like
            neo_credits)
          example:
            neo_ai: true
            neo_credits: 500
          type: object
        neo_cost_rate:
          description: >-
            Effective BYOK neo cost rate for the user. Returned when the user is
            in BYOK mode.
          format: float
          nullable: true
          type: number
        onboarding:
          $ref: '#/components/schemas/UserOnboardingStatus'
          description: >-
            Onboarding status flags for the user (active subscription, team
            membership)
        role:
          description: User's role in the system
          enum:
            - user
            - admin
          type: string
        tag:
          description: User tag (e.g., "free", "beta")
          nullable: true
          type: string
        team:
          $ref: '#/components/schemas/UserTeamInfo'
          description: Team membership information (null if user is not in a team)
          nullable: true
      required:
        - email
        - role
        - features
      type: object
    ErrorResponse:
      properties:
        code:
          description: >
            Stable machine-readable error code — branch on this rather than

            matching the human `error`/`message` strings. Domain codes include

            `user_spending_cap_reached`, `project_spending_cap_reached`, and

            `insufficient_neo_credits`; otherwise it mirrors the error kind

            (e.g. `forbidden`, `invalid_request`, `not_exists`,
            `already_exists`).
          example: user_spending_cap_reached
          type: string
        error:
          example: Bad request
          type: string
        error_id:
          description: Correlation id for a specific error instance, when present.
          type: string
        kind:
          description: Coarse error category (e.g. "forbidden request", "invalid request").
          example: forbidden request
          type: string
        message:
          description: |
            Human-readable detail (the kind prefixed to the error). For display,
            not for branching.
          type: string
      required:
        - error
      type: object
    ByokDiscoveredModel:
      properties:
        id:
          description: Provider-side model or deployment identifier shown to the user.
          type: string
        neo_model_id:
          description: Canonical Neo model label when supported.
          nullable: true
          type: string
        provider:
          description: BYOK provider id that exposed this model.
          type: string
        provider_model_id:
          description: Underlying provider/base model identifier when available.
          nullable: true
          type: string
        reason:
          description: >-
            Reason the row is not selectable, such as unsupported_by_neo or
            provider_discovery_failed.
          nullable: true
          type: string
        supported:
          description: >-
            Whether Neo supports executing this provider model through a
            canonical Neo model label.
          type: boolean
      required:
        - id
        - provider
        - supported
      type: object
    SpendingCapStatus:
      properties:
        limit:
          description: Effective cap in USD. null when source is "none".
          format: float
          nullable: true
          type: number
        remaining:
          description: limit − used, clamped ≥ 0. null when source is "none".
          format: float
          nullable: true
          type: number
        source:
          description: >-
            What the effective limit comes from — an explicit per-member
            override, the team-wide default, or none (bounded only by the team
            pool / not on a spend-controls plan).
          enum:
            - override
            - global_default
            - none
          type: string
        used:
          description: USD spent in the current cap window.
          format: float
          type: number
      required:
        - source
      type: object
    EgressIPInfo:
      properties:
        browser:
          $ref: '#/components/schemas/EgressIPSurfaceInfo'
          nullable: true
        sandbox:
          $ref: '#/components/schemas/EgressIPSurfaceInfo'
          nullable: true
        scope:
          description: Scope that provides the static egress IP, when known.
          enum:
            - user
            - team
          nullable: true
          type: string
      type: object
    UserOnboardingStatus:
      properties:
        subscription:
          description: True if the user (or their team) has an active subscription
          type: boolean
        team:
          description: True if the user belongs to a team
          type: boolean
      required:
        - subscription
        - team
      type: object
    UserTeamInfo:
      properties:
        auto_joined:
          description: >-
            Only present and true when user just auto-joined in this request
            (for first-time onboarding UI)
          type: boolean
        id:
          description: Team ID
          type: string
        name:
          description: Team name
          type: string
        role:
          $ref: '#/components/schemas/TeamMemberRole'
          description: User's role in the team
      required:
        - id
        - name
        - role
      type: object
    EgressIPSurfaceInfo:
      properties:
        ip_address:
          description: Static outbound IP address when mode is static.
          nullable: true
          type: string
        mode:
          description: Whether the surface currently uses dynamic or static outbound IP.
          enum:
            - dynamic
            - static
          type: string
      required:
        - mode
      type: object
    TeamMemberRole:
      description: >-
        Role of a team member (admin=full access, member=write access,
        viewer=read-only)
      enum:
        - admin
        - member
        - viewer
      type: string
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT authentication token
      scheme: bearer
      type: http
    ApiKeyAuth:
      description: Neo API key (neo_sk_* prefix)
      in: header
      name: X-Api-Key
      type: apiKey

````