Request: GET /user/{user_id}
When requesting GET /user/{user_id}, the values for the "Inactive" and "Employment Ended" statuses are the same — 3.
To differentiate between these statuses, use the GET /user/{user_id}/v2 request. In this way, in the status parameter, inactive users will be indicated by status 3, while users who are identified as "Employment Ended" will be indicated by status 5.
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles.
Department Administrators and users with a custom role can get information about users belonging only to the departments they manage and their sub-departments.
Request Headers
| Authorization (required) | Access token. You can obtain a token by making a request |
| Parameter | Description |
| user_id (required) | The user`s ID |
Response Parameters
| Parameter | Description | |
| userProfile | An array with user`s data | |
| userId | The user ID | |
| role | The user's role
| |
| departmentId | The ID of the department | |
| status | The user's status Possible values:
| |
| fields | An array with data about user profile fields. It includes profile field names and their values | |
| groups | An array with the group IDs the user is a member of | |
| manageableDepartmentIds | An array with the IDs of the departments the user manages | |
| userRoles | An array with data about the user's roles | |
| addedDate | The date the user was added to the account | |
| lastLoginDate | The date the user last timed logged in to the account | |
| subordination (optional) | An array with data on the type of department supervisor subordination | |
| coSubordination (optional) | An array with data on the type of functional manager subordination | |
| subordinationType (required) | The type of supervisor and functional manager subordination
| |
| workLeaveStatus (optional) | A work leave status. An array with the following parameters:
| |
| supervisorId (optional) | The supervisor and functional manager ID | Specify the supervisor ID, if subordinationType = manual |
| - | If subordinationType = inherit, no_supervisor, there is no need to specify the supervisor ID | |
Possible Response Codes
| 200 | OK | The request was successfully processed. The body of the response will contain xml data with user info |
| 400 | Bad Request | A request error |
| 401 | Unauthorized | An authorization error |
| 403 | Permission Denied | The user doesn't have enough permissions to complete the request |
Sample Request
|
Sample Response
|