The GET Users List API endpoint allows you to retrieve a comprehensive list of all users within the Alvys system.
The List Users API endpoint is used for fetching comprehensive details of all users, helping administrators and managers keep track of user accounts and their associated roles and permissions within the Alvys system. The inclusion of versioning in the URL path ensures compatibility with different API versions as the platform evolves. For more information on versioning, refer to the Versioning page.
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. |
Example CURL request
curl --location 'https://integrations.alvys.com/api/p/v{version}/users/list' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Replace {version} with the API version number and YOUR_ACCESS_TOKEN with your actual Bearer token.
curl --location 'https://integrations.alvys.com/api/p/v1/users/list' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...'
Response Parameters
The response contains a list of users, each represented by the following parameters:
| Parameter | Type | Description |
|---|---|---|
| id | String | The unique identifier of the user. |
| userName | String | The username of the user. |
| name | String | The full name of the user. |
| String | The email address of the user. | |
| userType | String | The type of user (e.g., Internal, External). |
| role | String | The role assigned to the user (e.g., Admin, User). |
| phone | String | The phone number of the user. |
| companyCode | String | The code of the company the user is associated with. |
| status | String | The current status of the user (e.g., Active, Inactive). |
| permissions | Array of Strings | A list of permissions assigned to the user. |
| createdAt | String (Date-Time) | The date and time when the user was created. |
| 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 without any 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.