Skip to main content
POST
Search users
The Search Users API endpoint allows users to search for specific user accounts within the Alvys system based on a keyword. This endpoint helps administrators efficiently find and manage user data by providing detailed information about users matching the search criteria.

Request Parameters

The following parameter is required in the URL path:

Request Body

The request body must include the following parameters: <Table> ParameterTypeRequiredDescription PageNumberYesThe page number for pagination.PageSizeNumberYesThe number of results per page.
PageSize must be greater than 0.
KeywordStringNoThe keyword to search for in user data. </Table>

Example CURL request

Use the Current API version number and make sure to replace the Authorization header value with your actual Bearer token for the request:

Response Parameters

The response contains a list of users matching the search criteria, each represented by the following parameters:

Example Response

On the right side, you can see examples of different error codes by clicking “Example” and selecting the response code.

Rate Limits

All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information on rate limits, please refer to the Rate Limits section. This page is interactive, allowing you to try a request by completing the fields for the parameters below. As you fill out the parameters, the Curl command on the right side of the page will be automatically updated. Alternatively, you can directly edit the Curl command. Make sure to authorize yourself before trying a request.

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.

Path Parameters

version
string
default:1.0
required

API version (e.g., 1.0)

Example:

"1.0"

Body

Page
integer<int32>
required
PageSize
integer<int32>
required
Keyword
string | null

Response

OK

Page
integer<int32>
required
PageSize
integer<int32>
required
Total
integer<int64>
required
Items
object[]
required
Facets
object | null