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

Path Parameters

​
id
integer<int64>
required

Query Parameters

​
email
string | null
​
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:
{
  "email": "[email protected]",
  "firstName": "Jane",
  "lastName": "Doe",
  "id": 5,
  "isEnabled": true,
  "userId": 1
}