Users / Entity
List User Hierarchy
This endpoint retrieves the hierarchy of a User based on JSON input. Specifically, an array of JSON data is returned, that reports the id and the name of each user that are below the requested User, on a hierarchical perspective.
You will only receive the User hierarchy after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
REQUEST
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier of the User |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| id | Object, Null | Unique identifier of the User (see Users resource) |
| name | String | User's name |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
get/users/{ID}/hierarchy
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/users/{ID}/hierarchy
- Auth: API key in header X-Session-Key
Headers
Acceptstring
X-FM-Entity-Countstring
Response
List User Hierarchy
Changes
No recorded changes to this operation across all 1 revision of this API.