List Users in Role
Returns all Users assigned to the specific Role available in the user's ForceManager implementation database.
You will only receive the List of Users assigned to the specific Role 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 |
REQUEST
You can apply filters, organise and choose the language and pagination using any query string parameter in SQL. Query string parameters appear after a question mark in the endpoint followed by the parameters and their values. In the query string, each parameter is listed one right after the other with an "and" separating them. The order of the parameters does not matter.
| Parameter | Type | Description |
|---|---|---|
| page | Integer | Define the pagination data for the returned objects |
| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |
| order | String | organise and view the results for a specific attribute in descendent order - at the top the most recent results while the oldest results will be down the list |
| lang | String | Define the language in which you want to receive the response |
You can define the pagination data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.
e.g.
<pre>https://api.forcemanager.com/api/v4/roles/:ID/users?page={{number}</pre>You can apply filters.
e.g.
<pre> https://api.forcemanager.com/api/v4/roles/:ID/users?where= param1=value AND/OR param2=value2</pre>You can also organise and view the results for Users in descendent order - at the top, the most recent results while the oldest results will be down the list.
e.g.
<pre>https://api.forcemanager.com/api/v4/roles/:ID/users?order=VALUE </pre>In the request, and using query string parameters, you can also define the language in which you want to receive the response.
e.g.
<pre> https://api.forcemanager.com/api/v4/roles/:ID/users?lang=VALUE</pre>RESPONSE
This endpoint returns information about all Users assigned to the specific Role 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 50.
List of the supported Users attributes:
| Attribute | Type | Description |
|---|---|---|
| billable | Boolean | If true, the User is billable. ForceManager charges a fee for the user |
| branches | Object, Null | Branch to which the User has been assigned |
| branchRestriction | Boolean | If true, the user has limited visibility in some branches |
| computeSfm | Boolean | If true, the User counts for the Sales Analytics |
| dateCreated | String | Date and time when the User was created |
| dateDeleted | String | Date and time when the User was deleted |
| dateUpdated | String | Date and time when the User was last updated |
| deleted | Boolean | If true, the User has been deleted and archived |
| String | User’s email | |
| extId | String | External ID of the User from a third party system (ERP, CRM, Accounting System) |
| id | Integer | The unique identifier of the User in ForceManager |
| lastName | String | User’s last name |
| lastPasswordChangeDate | String | Date when the password was last changed |
| level | Integer | Permission level of the user. Set from 1 to 5 being 5 the highest level of permission and visibility |
| name | String | User's first name |
| nic | String | User's name in ForceManager |
| phone | String | User’s phone number |
| phoneExtension | String | User's phone number extension |
| rateId | Object, Null | Rate for the User (Check Rates Values List) |
| salesRepId | Object, Null | Sales representative responsible for the User |
| salesRepIdCreated | Integer | Unique identifier of the user who created the User |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the User |
| salesRepIdUpdated | Integer | Unique identifier of the user who updated the User |
| session | Object, Null | If true, the User has access to the app |
| userType | Object, Null | Type of user in ForceManager |
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 |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/roles/{ID}/users
- Auth: API key in header X-Session-Key
Headers
Response
List Users in Role
Changes
No recorded changes to this operation across all 1 revision of this API.