Skip to main content
GET
/
platform
/
admin
/
users
cURL
curl --request GET \
  --url https://api.example.com/platform/admin/users
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.numium.com/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
Id
integer<int64> | null

Optional user identifier filter.

Example:

1

​
Email
string | null

Optional email filter.

Example:

"admin@example.com"

​
api-version
string | null

Response

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{
  "platformUsers": [
    {
      "userId": 1,
      "email": "admin@example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "isEnabled": true
    }
  ],
  "pendingInvitations": [
    {
      "userId": 2,
      "email": "pending@example.com",
      "invitedDate": "2025-11-04T10:30:00Z"
    }
  ]
}