Users / Entity
Get User
This endpoint retrieves data of a specific User based on JSON input. The API returns a single User available to the user, according to the unique ID provided. If the specified User does not exist, the response will be a "bad request".
You will only receive the 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 |
REQUEST
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier of the User |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| isActive | Boolean | If true, the User is activated. It is visible and can login in the apps |
| billable | Boolean | If true, the User is billable. ForceManager charges a fee for the user |
| branches | Object, Null | Branches to which the User belongs to (see Branches resource) |
| 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 |
| managerId | Object, Null | Unique identifier of the parent of the User (see Users resource) |
| name | String | User's first name |
| nic | String | User's name in ForceManager |
| phone | String | User's phone number |
| idPrefix | Integer | User's phone number Country ID (see Countries resource) |
| phoneExtension | String | User's phone number extension |
| rateId | Object, Null | Rate for the Order Header (see Rates resource) |
| 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 |
| locale | String | The User locale. The values can be: "ES", "EN", "US", "IT", "DE", "PT", "BR", "RU" |
| dbLanguage | String | The User database language. The values can be: "ES", "EN", "US", "IT", "DE", "PT", "BR", "RU" |
| uiLanguage | String | The User UI language (the language in the mobile apps and webapp). The values can be: "ES", "EN", "US", "IT", "DE", "PT", "BR", "RU" |
| userType | Object, Null | Type of the User (see Types resource) |
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}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/users/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
X-FM-Entity-Countstring
Response
Get User
Changes
No recorded changes to this operation across all 1 revision of this API.