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

# List Users

> API key permission: Users (Admin also opens it).



## OpenAPI

````yaml /api-reference/openapi.json get /users/list
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:
  /users/list:
    get:
      tags:
        - Users
      summary: List Users
      description: 'API key permission: Users (Admin also opens it).'
      operationId: list_users_users_list_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number, starting from 1
            default: 1
            title: Page
          description: Page number, starting from 1
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Number of items per page
            default: 20
            title: Page Size
          description: Number of items per page
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Optional search term for filtering users
            title: Search
          description: Optional search term for filtering users
        - name: ids
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            description: Optional user IDs to resolve; bypasses pagination
            title: Ids
          description: Optional user IDs to resolve; bypasses pagination
        - name: sort_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 'Optional sort field: email, name, role, client, or lastLogin'
            title: Sort By
          description: 'Optional sort field: email, name, role, client, or lastLogin'
        - 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/PaginatedUserList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PaginatedUserList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/UserListItem'
          type: array
          title: Items
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      type: object
      required:
        - items
        - meta
      title: PaginatedUserList
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserListItem:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
        email:
          type: string
          title: Email
        role:
          anyOf:
            - $ref: '#/components/schemas/UserRole'
            - type: 'null'
        user_type:
          anyOf:
            - $ref: '#/components/schemas/UserType'
            - type: 'null'
        pricing_plan_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Pricing Plan Id
        organization_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Organization Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        groups:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Groups
        last_login:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Login
        client:
          anyOf:
            - type: string
            - type: 'null'
          title: Client
      type: object
      required:
        - email
      title: UserListItem
    PaginationMeta:
      properties:
        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:
        - total
        - page
        - page_size
        - total_pages
      title: PaginationMeta
    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
    UserRole:
      type: string
      enum:
        - Admin
        - Member
        - Viewer
      title: UserRole
    UserType:
      type: string
      enum:
        - individual
        - team
        - enterprise
      title: UserType
  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.