Contacts / Types
List Contact Types
Returns all Contact Types available in the user's ForceManager implementation database.
You will only receive the List of Contact 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 |
| X-FM-Entity-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 Contact 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 Contact Types attributes:
| Attribute | Type | Description |
|---|---|---|
| branchVisibility | Object, Null | In which Branch the Contact Type is visible |
| dateCreated | String | Date and time when the Contact Type was created |
| dateDeleted | String | Date and time when the Contact Type was deleted |
| dateUpdated | String | Date and time when the Contact Type was last updated |
| deleted | Boolean | If true, the Contact Type has been deleted and archived |
| descriptionBR | String | Contact Type label in Brasilian Portuguese |
| descriptionDE | String | Contact Type label in German |
| descriptionDK | String | Contact Type label in Dutch |
| descriptionEN | String | Contact Type label in English |
| descriptionES | String | Contact Type label in Spanish |
| descriptionFR | String | Contact Type label in French |
| descriptionIT | String | Contact Type label in Italian |
| descriptionPT | String | Contact Type label in Portuguese |
| descriptionRU | String | Contact Type label in Russian |
| descriptionUS | String | Contact Type label in American English |
| id | Integer | Unique identifier for the Contact Type in ForceManager |
| order | Integer | The position of the Contact Type in the Contact Types value list |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Contact Type |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Contact Type |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Contact 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/contactTypes
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/contactTypes
- Auth: API key in header X-Session-Key
Headers
Acceptstring
X-FM-Entity-Countstring
ExtraFieldDescriptionstring
Response
List Contact Types
Changes
No recorded changes to this operation across all 1 revision of this API.