Versions Compared

Old Version 1

changes.mady.by.user Alina Levitskaya

Saved on

compared with

New Version 2

changes.mady.by.user Alina Levitskaya

Saved on

Key

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

...

Department Administratorscan get users belonging to the departments they manage and their sub-departments.

Request Headers

Header

Description

Authorization (required)Access token. You can obtain a token by making a request
ParameterDescription

departments (optional)

An array of IDs of the departments whose users you want to retrieve

groups (optional)

An array of IDs of the groups whose users you want to retrieve

pageSize (optional)The number of entries per page. If not indicated, equal to 1000
pageToken (optional)The token to continue to the next page

logins (optional)

An array of logins whose users you want to retrieve
emails (optional)An array of emails whose users you want to retrieve
workLeaveStatus (optional)

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

Response Codes

Code

Text

Description

200OKThe request has been successfully processed
400Bad RequestA request error
401UnauthorizedAn authorization error
403Permission DeniedThe user doesn't have enough permissions to retrieve a list of users

Sample Request

Code Block
languagexml
GET/users?departments[]=f0050578-c3dd-11e9-9d5d-4a54cfb3a702&groups[]=2aa6c5d2-fa51-11e9-b3bf-0a580af40a83&pageSize=1&pageToken=MmFiZmJhNDItZmE1MS0xMWU5LTk1ZjAtMGE1ODBhZjQwYTgz https/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: https://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password

...