Search users and their information by extended filter

GET /api/2.0/people/filter

Request

Returns a list of users with full information about them 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/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/filter \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of users with their information

FirstNamestring

LastNamestring

UserNamestring

Emailstring

Birthdaystring

Sexstring

Statusenum of integerformat: int32

[1 - Active, 2 - Terminated, 4 - LeaveOfAbsence, 5 - Default, 7 - All]

Can be one of: Active, Terminated, LeaveOfAbsence, Default, All.

ActivationStatusenum of integerformat: int32

[0 - NotActivated, 1 - Activated, 2 - Pending, 4 - AutoGenerated]

Can be one of: NotActivated, Activated, Pending, AutoGenerated.

Terminatedstring

Departmentstring

WorkFromstring

Groupsarray of object

Namestring

Idstringformat: uuid

Managerstring

Locationstring

Notesstring

Leadstringformat: uuid

AvatarMediumstring

Avatarstring

IsAdminboolean

IsLDAPboolean

ListAdminModulesarray of string

IsOwnerboolean

IsVisitorboolean

CultureNamestring

IsSSOboolean

QuotaLimitintegerformat: int64

UsedSpaceintegerformat: int64

DocsSpaceintegerformat: int64

MailSpaceintegerformat: int64

TalkSpaceintegerformat: int64

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

401

Unauthorized