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

# Get all users

> Returns a paginated list of [users](/concepts/user) with optional filtering via [criterias](/api-reference/criterias).



## OpenAPI

````yaml POST /user/get_all
openapi: 3.0.0
info:
  version: 2.0.0
  title: illuxiLMS API
  description: Interact with the illuxiLMS API to manage your learning content and users.
  termsOfService: https://illuxi.com/conditions-utilisation/
  contact:
    name: illuxi Team
    email: info@illuxi.com
    url: https://illuxi.com
servers:
  - url: https://{portalApiUrl}
    description: Production server (uses live data)
    variables:
      portalApiUrl:
        default: your-portal.acme.com/api-v2
        description: Your portal's API URL
security:
  - bearerAuth: []
paths:
  /user/get_all:
    post:
      description: >-
        Returns a paginated list of [users](/concepts/user) with optional
        filtering via [criterias](/api-reference/criterias).
      operationId: getAllUsers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/GetAllRequest'
                - type: object
                  properties:
                    index_by_user_id:
                      type: boolean
                      description: >-
                        If true, result is keyed by user_id instead of a plain
                        array
                    order_by:
                      type: string
                      description: Sort expression (e.g. "user_id asc")
            example:
              index_by_user_id: true
              start: 0
              limit: 10
              order_by: user_id asc
              criterias: []
      responses:
        '200':
          description: list of users
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                  total:
                    type: integer
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    GetAllRequest:
      type: object
      properties:
        start:
          type: integer
          description: Offset for pagination
          default: 0
        limit:
          type: integer
          description: Maximum number of records to return
          default: 10
        criterias:
          type: array
          description: List of filter criteria
          items:
            type: object
            required:
              - column
              - operator
              - value
            properties:
              column:
                type: string
                description: Field name to filter on
              operator:
                type: string
                description: Comparison operator
                enum:
                  - equal
                  - not_equal
                  - like
                  - in
                  - not_in
                  - greater_than
                  - less_than
                  - greater
                  - lesser
              value:
                description: Value to compare against
    User:
      type: object
      properties:
        user_id:
          type: integer
          description: Unique identifier of the user
          readOnly: true
        email:
          type: string
          format: email
          description: Email address of the user
        firstname:
          type: string
          description: First name of the user
        lastname:
          type: string
          description: Last name of the user
        user_status:
          type: string
          description: Account status
          enum:
            - active
            - inactive
          readOnly: true
        user_organisation_identifier:
          type: string
          nullable: true
          description: Organisation-specific identifier for the user
        groups:
          type: array
          description: List of group keys the user belongs to
          items:
            type: string
          readOnly: true
        properties:
          type: object
          description: Custom property key-value pairs
          additionalProperties: true
        user_created_date:
          type: string
          format: date-time
          readOnly: true
          description: Date the user was created
        user_updated_date:
          type: string
          format: date-time
          readOnly: true
          description: Date the user was last updated
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Authentication token obtained from POST /token

````