Versions Compared

Key

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

...

ParameterTypeDescription
token (required)stringAccess token. You can obtain a token by making a request
userId (required)stringID of the user whose information you want to get

...

ParameterTypeDescription
userIdstringID of the specified user
statusintUser status: 1 — active, 3 — inactive
departmentIdstringID of the department the user belongs to
emailstringThe email of the user
groupsstring[]IDs of groups the user belongs to
fieldsstring[][2]User profile fields — an array of objects with the following properties: Id, value
addedDatedate

The date the user was added to the account

lastLoginDatedate

The date the user last timed logged in to the account

manageableDepartmentIdsstring[]

IDs of departments the users manages if their role is Department Administrator

rolestring

The user's role

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

...