Selecting a User

This step shows how to get details of a specific user.

Example payload:

CURL

curl --location --request GET 'https://<DOMAIN>/xapi/v2/user/:USER_GUID' \
--header 'Content-Type: x-www-form-urlencoded'

NodeJS

client.users.getUser("C9FE6854-8147-4D55-AE55-C5F2A1D65855");

Python

#get user by user_id
client.users.get_user_by_id("C9FE6854-8147-4D55-AE55-C5F2A1D65855");

#get user by name
client.users.get_user_by_username("John");

Example response:

A successful operation will return 200 OK with the following body:

{
    "user_guid": "C9FE6854-8147-4D55-AE55-C5F2A1D65855",
    "name": "John",
    "surname": "Doe",
    "username": "johndoe",
    "email": "[email protected]",
    "role": "u",
    "mobile": "",
    "login_allowed": true,
    "status": 1,
    "lang": "en-US",
    "timezone": "Europe/Istanbul",
    "expires_at": null,
    "creation_date": "2024-06-04T11:48:52.285253+03:00",
    "updating_date": "2025-01-20T10:59:33.080894+03:00"
}