Read Users Records
GET {{url}}/{{tenantName}}/admin/users
User Record API url consist of the following structure
https://api.live.welkincloud.io/{}/admin/users/{}
In our example, the url would be: https://api.live.welkincloud.io/gh/admin/users/johndoe
- HTTP Method: GET
- HTTP URL:
https://api.live.welkincloud.io/gh/admin/users/johndoe
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
email | null | ||
ids | null | uuid,uuid,uuid...... | |
firstName | null | string | |
lastName | null | string | |
region | null | string | |
territories | null | string,string,string.... | |
Works only with seted region filter | |||
roleName | null | string | |
includeDeleted | boolean | ||
page | number | Pagination: page number | |
size | null | Pagination: page size | |
sort | null | Sort field with sorting order(asc or desc) after coma |