API Version 1.2
API Documentation for developers
Getting list of contacts
URL: /api/contacts.format
Method: GET
Overview:
This resource contains all summarized information about contacts.
| Name | Type | Description |
| system_tag | string | Show contacts only with given system tag attached. |
| tag | string | Show contacts only with given custom tag attached.1 Note: if you want to get only VIP contacts, put "VIP" here. |
| search | string | Search phrase (only contacts with this phrase in first/last/company name will be returned |
| page | integer | Number of the page which should be displayed (number of items in page are stored in users settings and have been provided during login process). When this number will exceed maximum number of available pages, empty result will return. |
| waiting | boolean | When true, only contacts with "waiting for" next action will be returned. If false or if this parameter will not be given, such contacts won’t be returned. |
| filter_id | string | Custom filter ID. If valid provided, tag, system_tag and mode parameters will be ignored. |
| Name | Type | Description |
| count | integer | Total count of contacts found |
| page | integer | Current page number |
| maxpage | integer | Max. page number available for these filter conditions. |
| contacts | array | Array of contacts data (each element is described in the table below |
| Name | Type | Description |
| id | string | Contact ID |
| firstname | string | First name |
| lastname | string | Last name |
| company | string | Company name |
| status | string | Contact status |
| tags | array[string] | Tags attached to contact |
| pendingdeal | boolean | Information if there are some pending deals attached to this contact |
| vip | boolean | Information if contact is marked as VIP |
| nextaction | hash | Information about next action (may be empty). It contains three elements:
|
- 1) This parameter will be ignored if system_tag parameter is present and is valid.
Sample JSON server response for getting list of contacts.
