The method allows you to get a list of companies
Limitations
The method is available in correspondence to the user rights.
“with” Parameters
| Parameter | Description |
|---|---|
| leads | Adds info on the leads linked to the company into the response |
| contacts | Adds info on the contacts linked to the company into the response |
| catalog_elements | Adds lists elements linked to the company into the response |
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
The properties of a company object are listed below.
Parameter | Data type | Description |
|---|---|---|
id | int | Company ID |
name | string | Company name |
responsible_user_id | int | Company responsible user ID |
group_id | int | Group ID of the company responsible user |
created_by | int | The ID of the user who created the company |
updated_by | int | The ID of the user who updated the company last |
created_at | int | Company creation date in the format of Unix Timestamp |
updated_at | int | Company 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 company custom fields’ values |
account_id | int | Account ID where the company is located in |
| object | Embedded entities data |
| array | Company tags data array |
| object | Company tag model |
| int | Tag ID |
| string | Tag name |
| string/null | Tag color |
| array | GET parameter “with” is required. |
| object | Linked contact data |
| int | Linked contact ID |
| array | GET parameter “with” is required. |
| object | Linked lead data |
| int | Linked lead ID |
| array | GET parameter “with” is required. |
| object | Linked list element data |
| int | Linked element ID |
| object | Meta-data of the element |
| int | Linked elements quantity |
| int | ID of the linked element’s list |