Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
bgColor#EAF4FD

When requesting getUsers, the values for the "Inactive" and "Employment Ended" statuses are the same — 3. To differentiate between these statuses, use the getUsers/v2 request. In this way, in the status parameter, inactive users will be indicated by status 3, while users who are identified as "Employment Ended" will be indicated by status 5.

If you have more than 1000 users in your account, use the Getting a List of Users (Page-by-Page) request.

Permissions to Run the Request

...

ParameterTypeDescription
token (required)stringAccess token. You can obtain a token by making a request
groupId (optional)stringIf specified, this method selects users belonging to a specific group
departmentId (optional)intIf specified, this method selects users belonging to a specific department

...

ParameterTypeDescription
usersUserProfile[]An array of user profiles. The UserProfile object has the same properties as the getUserProfile method
workLeaveStatus (optional)string

A work leave status. An array with the following parameters:

  • workLeaveReason  
    Reasons for work leave status
  • startDate
    The work leave status start date. You can add it in the yyyy-mm-dd format
  • endDate
    The work leave status end date. You can add it in the yyyy-mm-dd format

...