List Contacts
Returns all Contacts available in the user's ForceManager implementation database.
You will only receive the List of Contacts 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 |
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.
https://api.forcemanager.com/api/v4/contacts?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/contacts?where= param1=value AND/OR param2=value2
You can filter Contacts by firstName or accountId, or typeId for example.
You can also organise and view the results for Contacts in descendent order - at the top, the most recent results while the oldest results will be down the list.
e.g.
https://api.forcemanager.com/api/v4/contacts?order=VALUE
In the request, and using query string parameters, you can also define the language in which you want to receive the response.
e.g.
https://api.forcemanager.com/api/v4/contacts?lang=VALUE
RESPONSE
This endpoint returns information about all Contacts 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 Contacts attributes:
| 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 | User 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 |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/contacts
- Auth: API key in header X-Session-Key
Headers
Response
List Contacts
Changes
No recorded changes to this operation across all 1 revision of this API.