Skip to main content
POST
/
user
/
get_all
cURL
curl --request POST \
  --url https://{portalApiUrl}/user/get_all \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "index_by_user_id": true,
  "start": 0,
  "limit": 10,
  "order_by": "user_id asc",
  "criterias": []
}
'
{
  "status": true,
  "total": 123,
  "result": [
    {
      "user_id": 123,
      "email": "jsmith@example.com",
      "firstname": "<string>",
      "lastname": "<string>",
      "user_organisation_identifier": "<string>",
      "groups": [
        "<string>"
      ],
      "properties": {},
      "user_created_date": "2023-11-07T05:31:56Z",
      "user_updated_date": "2023-11-07T05:31:56Z"
    }
  ]
}

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.

Authorizations

​
Authorization
string
header
required

Authentication token obtained from POST /token

Body

application/json
​
start
integer
default:0

Offset for pagination

​
limit
integer
default:10

Maximum number of records to return

​
criterias
object[]

List of filter criteria

​
index_by_user_id
boolean

If true, result is keyed by user_id instead of a plain array

​
order_by
string

Sort expression (e.g. "user_id asc")

Response

list of users

​
status
boolean
​
total
integer
​
result
object[]