Retrieve a users list for given search criteria

Request

Security

OAuth2(Required scopes: users.read)

Query

searchstring(Search text used to find users.)

activeboolean(Is active flag used to filter users.)

rolesArray of strings(User roles used to filter on.)

limitinteger, >= 0(The limit used for this page of results.)

Default:20

offsetinteger, >= 0(The offset used for this page of results.)

Default:0

curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/users?search=string&active=true&roles=installationAdmin&limit=20&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json

dataArray of objects(Data)required

totalCountinteger(Totalcount)required

limitinteger(Limit)required

offsetinteger(Offset)required

Response

{
  "data": [
    { … }
  ],
  "totalCount": 0,
  "limit": 0,
  "offset": 0
}