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

# Get Usage By User

> API key permission: Admin.



## OpenAPI

````yaml /api-reference/openapi.json get /usage/by-user
openapi: 3.1.0
info:
  title: Neural Factory API
  version: 0.1.0
  description: >-
    The endpoints a program can call with an API key. Exchange the key's secret
    for a token at POST /apikeys/token and send it as a Bearer token.
servers:
  - url: https://api.neuralfactory.ai
    description: SaaS
  - url: https://{apiHost}
    description: 'Enterprise: the API address of your own deployment'
    variables:
      apiHost:
        default: api.example.com
        description: Your deployment's API host
security:
  - bearerAuth: []
tags:
  - name: API keys
  - name: Chat
  - name: Runs
  - name: Agents
  - name: Workflows
  - name: Schedules
  - name: Knowledge bases
  - name: Documents
  - name: Search
  - name: Skills
  - name: Toolkits
  - name: Files
  - name: Interactions
  - name: Usage and billing
  - name: Catalogue
  - name: Browser
  - name: Users
  - name: Groups
  - name: Builds
paths:
  /usage/by-user:
    get:
      tags:
        - Usage and billing
      summary: Get Usage By User
      description: 'API key permission: Admin.'
      operationId: get_usage_by_user_usage_by_user_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number
            default: 1
            title: Page
          description: Page number
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Items per page
            default: 10
            title: Page Size
          description: Items per page
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Search by user name or email
            title: Search
          description: Search by user name or email
        - name: sort_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Sort field
            title: Sort By
          description: Sort field
        - name: sort_order
          in: query
          required: false
          schema:
            type: string
            description: 'Sort order: asc or desc'
            default: asc
            title: Sort Order
          description: 'Sort order: asc or desc'
        - name: env
          in: query
          required: false
          schema:
            title: Env
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserUsageListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UserUsageListResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/UserUsageItem'
          type: array
          title: Items
        total:
          type: integer
          title: Total
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - items
        - total
        - page
        - page_size
        - total_pages
      title: UserUsageListResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserUsageItem:
      properties:
        user_id:
          type: string
          title: User Id
        user_name:
          type: string
          title: User Name
        email:
          type: string
          title: Email
        usage:
          type: number
          title: Usage
        limit:
          type: number
          title: Limit
        percentage:
          type: number
          title: Percentage
        client:
          anyOf:
            - type: string
            - type: 'null'
          title: Client
        on_demand_spent:
          anyOf:
            - type: number
            - type: 'null'
          title: On Demand Spent
        on_demand_limit:
          anyOf:
            - type: number
            - type: 'null'
          title: On Demand Limit
      type: object
      required:
        - user_id
        - user_name
        - email
        - usage
        - limit
        - percentage
      title: UserUsageItem
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The access_token returned by POST /apikeys/token for an API key's
        secret.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.