Users / Types
List User Types
Returns all User Types available in the user's ForceManager implementation database.
You will only receive the List of User Types 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 |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
| ExtraFieldDescription | {number} | If equal to "0", the response returns only the value of each Extra Fields, if equal to "1" also the description is returned |
RESPONSE
This endpoint returns information about all User Types 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 User Types attributes:
| Parameter | Type | Description |
|---|---|---|
| branchVisibility | Object, Null | In which Branch the User Type is visible |
| dateCreated | String | Date and time when the User Type was created |
| dateDeleted | String | Date and time when the User Type was deleted |
| dateUpdated | String | Date and time when the User Type was last updated |
| deleted | Boolean | If true, the User Type has been deleted and archived |
| descriptionBR | String | User Type label in Brasilian Portuguese |
| descriptionDE | String | User Type label in German |
| descriptionDK | String | User Type label in Dutch |
| descriptionEN | String | User Type label in English |
| descriptionES | String | User Type label in Spanish |
| descriptionFR | String | User Type label in French |
| descriptionIT | String | User Type label in Italian |
| descriptionPT | String | User Type label in Portuguese |
| descriptionRU | String | User Type label in Russian |
| descriptionUS | String | User Type label in American English |
| id | Integer | Unique identifier for the User Type in ForceManager |
| order | Integer | The position of the User Type in the User Typees value list |
| salesRepIdCreated | Integer | Unique identifier of the user who created the User Type |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the User Type |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the User Type |
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/userTypes
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/userTypes
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Countstring
ExtraFieldDescriptionstring
Response
List User Types
Changes
No recorded changes to this operation across all 1 revision of this API.