This method allows to get a list of contacts in the account
Limitations
Method is available in correspondence to the user rights.
“with” Parameters
| Parameter | Description |
|---|---|
| leads | Adds info on the leads linked to the contact into the response |
| catalog_elements | Adds lists elements linked to the contact into the response |
Find contact by a phone number
You can easily filter your contacts by
?query={CONTACT_PHONE}parameter to get them by a phone number.
Data type header when the request is successful
Content-Type: application/hal+json
Data type header in case of an error
Content-Type: application/problem+json
Response parameters
Parameter | Data type | Description |
|---|---|---|
id | int | Contact ID |
name | string | Contact fullname |
first_name | string | Contact first name |
last_name | string | Contact last name |
responsible_user_id | int | Contact responsible user ID |
group_id | int | Group ID of the contact responsible user |
created_by | int | ID of the user who created the contact |
updated_by | int | ID of the user who updated the contact last |
created_at | int | Contact creation date in the format of Unix Timestamp |
updated_at | int | Contact update date in the format of Unix Timestamp |
closest_task_at | int | Date of the closest open task in the format of Unix Timestamp |
custom_fields_values | array|null | An array of the current contact custom fields’ values |
account_id | int | Account ID where the contact is located in |
_embedded | object | Embedded entities data |
_embedded[tags] | array | Contact tags data array |
_embedded[tags][0] | object | Contact tag model |
_embedded[tags][0][id] | int | Tag ID |
_embedded[tags][0][name] | string | Tag name |
_embedded[tags][0][color] | string/null | Tag color |
_embedded[companies] | array | Contact tag model |
_embedded[companies][0] | object | Linked company data |
_embedded[companies][0][id] | int | Linked company ID |
_embedded[leads] | array | GET parameter “with” is required. |
_embedded[leads][0] | object | Linked lead data |
_embedded[leads][0][id] | int | Linked lead ID |
_embedded[catalog_elements][catalog_elements] | array | GET parameter “with” is required. |
_embedded[catalog_elements][0] | object | Linked list element data |
_embedded[catalog_elements][0][id] | int | Linked element ID |
_embedded[catalog_elements][0][metadata] | object | Meta-data of the element |
_embedded[catalog_elements][0][quantity] | int | Linked elements quantity |
_embedded[catalog_elements][0][catalog_id][catalog_id] | int | ID of the linked element’s list |