Roles
List Roles of User
Returns all the Roles assigned to the user in ForceManager account database based on JSON input. <br>You will only receive the List of Roles associated to the defined user 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 |
| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
RESPONSE
This endpoint returns information about the Roles associated to the defined user available in the database.
If you didn't apply any page or count number in the header the default number of records in the response is 100.
List of the supported Users attributes:
| Attribute | Type | Description |
|---|---|---|
| branches | Object, Null | List of the Role branches |
| extId | Integer | External ID of the Role from a third party system (ERP, CRM, Accounting System) |
| id | Integer | The unique identifier of the Role in ForceManager |
| level | Integer | Between 1-5. The priority of this Role, being 1 minor and 5 major |
| name | String | The name of the Role |
| dateCreated | String | Date and time when the Role was created |
| dateDeleted | String | Date and time when the Role was deleted |
| dateUpdated | String | Date and time when the Role was last updated |
| deleted | Boolean | If true, the Role has been deleted and archived |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Role |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Role |
| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Role |
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}/roles
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/users/{ID}/roles
- Auth: API key in header X-Session-Key
Headers
Acceptstring
X-FM-Entity-Countstring
Response
List Roles in User
Changes
No recorded changes to this operation across all 1 revision of this API.