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:

Parameter	Type	Required	Description
version	String	Yes	The version of the API being requested.

Request Body

The request body must include the following parameters:

Parameter	Type	Required	Description
page	Number	No	The page number for pagination.
pageSize	Number	Yes	The number of results per page. PageSize must be greater than 0.
keyword	String	No	The keyword to search for in user data.

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:

curl --location 'https://integrations.alvys.com/api/p/v1/users/search' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ....' \
--header 'Content-Type: application/json' \
--data-raw '{
  "page": 0,
  "pageSize": 100,
  "keyword": ""
}'

Response Parameters

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

Parameter	Type	Description
page	Number	The current page number.
pageSize	Number	The number of items per page.
total	Number	The total number of matching items.
items	Array	The list of users matching the search criteria.
items.id	String	The unique identifier of the user.
items.userName	String	The username of the user.
items.name	String	The full name of the user.
items.email	String	The email address of the user.
items.userType	String	The type of user (e.g., Internal, External).
items.role	String	The role assigned to the user (e.g., Admin, User).
items.phone	String	The phone number of the user.
items.companyCode	String	The code of the company the user is associated with.
items.status	String	The current status of the user (e.g., Active, Inactive).
items.permissions	Array of Strings	A list of permissions assigned to the user.
items.createdAt	String (Date-Time)	The date and time when the user was created.
items.modifiedAt	String (Date-Time)	The date and time when the user's details were last modified.

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.