Search users by nickname

get/users/search/by_nickname

Searches users by the nickname parameter and gets a list of them. Search can be performed instantly when the user starts entering the search parameter.

The workflow of using this call:

The user enters a nickname or tag, or nickname and tag.
The Xsolla Login server searches for users in the Login project data of the user who initiated a search.

The current user can execute this call only one time per second.

SecurityBearer

Request

query Parameters

nickname required	string [ 3 .. 255 ] characters The search string that may contain: nickname only. Search is performed by substring at the beginning of the nickname. tag only, is used with "#" at the beginning. Search is performed by substring at the beginning of the tag. nickname and tag together, is used with "#" and without space. Search is performed by full nickname and substring at the beginning of the tag.
offset	integer [ 0 .. 100 ] Default: 0 Number of the elements from which the list is generated.
limit	integer [ 1 .. 100 ] Default: 100 Maximum number of users that are returned at a time.

Responses

200

401

Unauthorized

422

Unprocessable Entity

429

Too Many Requests

Request samples

Response samples

application/json

{"offset": 0,
"total_count": 0,
"users": [{"avatar": "string",
"is_me": true,
"last_login": "string",
"nickname": "string",
"registered": "string",
"tag": "string",
"user_id": "string"
}
]
}