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

  1. HTTP Method: GET
  2. HTTP URL: https://api.live.welkincloud.io/gh/admin/users/johndoe

Request Params

KeyDatatypeRequiredDescription
emailnull
idsnulluuid,uuid,uuid......
firstNamenullstring
lastNamenullstring
regionnullstring
territoriesnullstring,string,string....
Works only with seted region filter
roleNamenullstring
includeDeletedboolean
pagenumberPagination: page number
sizenullPagination: page size
sortnullSort field with sorting order(asc or desc) after coma