Search users by extended filter

GET /api/2.0/people/simple/filter

Request

Returns a list of users matching the parameters specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

employeeStatusarray of integer

User status ("Active", "Terminated", "LeaveOfAbsence", "All", or "Default")

groupIdarray of string

Group ID

activationStatusarray of integer

Activation status ("NotActivated", "Activated", "Pending", or "AutoGenerated")

employeeTypearray of integer

User type ("All", "User", or "Visitor")

isAdministratorarray of boolean

Specifies if the user is an administrator or not

Examples

GET /api/2.0/people/simple/filter HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/people/simple/filter \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of users

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

401

Unauthorized