Versions Compared

Old Version 3

changes.mady.by.user Alina Levitskaya

Saved on

compared with

New Version Current

changes.mady.by.user Alina Levitskaya

Saved on

Key

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

...

Department Administrators, and users with a custom role can get lists of users belonging to the departments they manage and their sub-departments.

info
Panel
bgColor#eaf4fd

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

Request Headers

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

The array of departments IDs you want to get user lists of

groups (optional)The array of groups IDs you want to get user lists of
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

Possible Response Codes

CodeTextDescription
200OKThe request has been processed successfully
400Bad RequestA request error
401UnauthorizedAn authorization error
403Permission deniedThe user doesn't have enough permissions to complete the request

Sample Request

Code Block
languagexml
GET /user?departments[]=e95b4ad0-5f50-11e9-80c4-0a580af406eb&groups[]=e0b394fc-44b9-11e9-92c8-0a580af401f6 https/1.1
Host: api-learn.ispringlearn.com 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

...