Get User Hierarchy

This API returns the User Ids of all users under a particular reporting manager (based on the Reporting To field).

Note: You may optionally pass the UserId parameter in the query string. If you don’t pass it, results will be returned for the users who’s API credentials are being used.

 

API URL

GET
https://{host}/v2/UserManagement.svc/ReportingHierarchy/RetrieveAllReportingUsers?accessKey=AccessKey&secretKey=SecretKey&UserId=User Id
Copy URL

URL Parameters

Parameter Description
User Id Id of the user (reporting manager) under who you want to retrieve the hierarchy of users.

Response

200 OK

Content-Type: application/json

[
    "2871282f-8ee4-11e7-b0ab-02e89b2fb8f4",
    "3b1041fb-8374-11e7-8758-0a106ee76b21",
    "718ae557-9d0b-11e7-b0ab-02e89b2fb8f4",
    "9e660b12-6fdf-11e8-8455-020714094d7e"
]

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.