🕵️‍♀️Searching Users

This step shows how to filter users

Available parameters:

Parameter	Type	Description
name	string	Name of the user
surname	string	Surname of the user
email	string	Email of the user
username	string	Username of the user
user_id	string	GUID of the user
role	string	Role of the user (see)
mobile	string	Mobile of the user
page_size	integer	Page size
page_number	integer	Page number

If you like to see all users belonging to your account, you can achieve this by not sending any parameters to the request.

Example request:

CURL

curl -L -X POST 'https://<DOMAIN>/xapi/v2/user/search' \
-H 'Content-Type: application/json' \
-d '{
    "name": "john",
    "page_size": 10,
    "page_number": 1
}'

NodeJS

client.users.searchUsers({
        name: "john", page_size: 10, page_number: 1
    });

Python

#user_id, name, surname, username, email, role, mobile, page_size, page_number
client.users.search_user({
    "name": "John"
})

Example response:

[
    {
        "user_id": "<USER_ID>",
        "name": "john",
        "surname": "Doe",
        "username": "johndoe",
        "email": "[email protected]",
        "role": "u",
        "mobile": "",
        "login_allowed": true,
        "status": 1,
        "lang": "tr-TR",
        "timezone": null,
        "expires_at": null,
        "creation_date": "2024-08-01T00:45:03.8888474+00:00",
        "updating_date": null
    }
]