Contacts / Entity
Get Contact
This endpoint retrieves data of a specific Contact based on JSON input. The API returns a single Contact available to the user, according to the unique ID provided. If the specified Contact does not exist, the response will be a "bad request".
You will only receive the Contact 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 Contact |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| accountId | Object, Null | Account to whom the Contact is linked to (see Accounts resource) |
| address1 | String | Contact's first address |
| city | String | City name |
| comment | String | Comment added to the Contact profile |
| countryId | Object, Null | Country ID (see Countries resource) of the address |
| dateCreated | String | Date and time when the Contact was created |
| dateDeleted | String | Date and time when the Contact was deleted |
| dateUpdated | String | Date and time when the Contact was last updated |
| deleted | boolean | If true, the Contact has been deleted and archived |
| String | Contact's email address | |
| email2 | String | Contact's second email address |
| email3 | String | Contact's third email address |
| extId | String | External ID of the Contact from a third party system (ERP, CRM, Accounting System) |
| fax | String | Contact's fax number |
| firstName | String | Contact's first name |
| gender | Integer | Male -> 0 or female -> 1 |
| id | Integer | Unique identifier for the Contact in ForceManager |
| lastName | String | Contact's last name |
| String | Contact's LinkedIn profile name | |
| permissionLevel | String | Defines the visibility of the Contact. Set from 1 to 5 being 5 the highest level of permission |
| phone1 | String | Contact's first phone number |
| phone2 | String | Contact's second phone number |
| postcode | String | Postcode of the Contact address |
| readOnly | boolean | If true, the Contact cannot be modified or deleted |
| region | String | Region/State name referred to the address |
| salesRepId | Object, Null | Contact responsible for the Contact |
| salesRepIdCreated | Integer | Unique identifier of the User who created the Contact |
| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Contact |
| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Contact |
| skype | String | Contact's Skype name |
| typeId | Object, Null | Contact Type (see Type resource) |
| UseCompanyAddress | Boolean | If true, Contact's address is the one of the associated Account |
| birthday | String | Contact's birthday |
| marketingCommunications | Boolean | If true, Contact can receive marketing communications |
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/contacts/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/contacts/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Get Contact
Changes
No recorded changes to this operation across all 1 revision of this API.