Get a list of available users

get/users
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
username
string (StringFilterParam)

Filter by username

Example: username=xyz | in:x,y | like:xyz
email
string (StringFilterParam)

Filter email

Example: email=xyz | in:x,y | like:xyz
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "username": "string",
    • "firstName": "string",
    • "lastName": "string",
    • "email": "annon@annon.com",
    • "telephoneNumber": "string",
    • "mobileNumber": "string",
    • "contractOwnerId": 1,
    • "enabled": true,
    • "userRoles": [
      • 1
      ]
    }
]