This method allows getting a list of leads in the account
Limitations
The method is available in accordance with the user’s rights.
“with”parameters
| Parameter | Description |
|---|---|
| contacts | Adds information about the contacts associated with the lead to the response |
| only_deleted | If this parameter is passed, the method request will return only the deleted leads that are still restorable in the response. You will receive lead models with the following properties: “id”, modification date and “is_deleted” = true parameters. |
| loss_reason | Adds detailed information about the lead loss reason to the response |
| is_price_modified_by_robot | Adds a property represents whether the lead sale value was changed last time by Robot to the response |
| catalog_elements | Adds lists items linked to the lead to the response |
| source_id | Adds the lead source ID to the response |
filter[statuses]
Due to the service limitations, you can filter only one stage in one pipeline. But it is possible to filter several stages within several pipelines outside of the service.
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 | Lead ID |
name | string | Lead name |
price | int | Lead sale |
responsible_user_id | int | Lead responsible user ID |
group_id | int | Group ID of the lead responsible user |
status_id | int | ID of the stage the lead is added to, the first stage of the main pipeline by default |
pipeline_id | int | ID of the pipeline the lead is added to |
loss_reason_id | int | Lead loss reason ID |
source_id | int | GET parameter “with” is required. |
created_by | int | Id of the user who created the lead |
updated_by | int | Id of the user who updated the lead |
created_at | int | The time and date the lead was created in the format of Unix Timestamp |
updated_at | int | The time and date the lead was updated in the format of Unix Timestamp |
closed_at | int | The time and date the lead was closed in the format of Unix Timestamp |
closest_task_at | int | The time and date of the closest open task in the format of Unix Timestamp |
custom_fields_values | array|null | An array containing information on the values of custom fields specified for this lead |
score | int|null | Lead score |
account_id | int | Account ID where the lead is located in |
labor_cost | int | Shows how much time was spent working with the deal. Calculation time in seconds. |
is_price_modified_by_robot | bool | GET parameter “with” is required. |
| object | Embedded entities data |
| object | GET parameter “with” is required. |
| int | Loss reason ID |
| string | Loss reason name |
| array | Lead tags data array |
| object | Lead tag model |
| int | Tag ID |
| string | Tag name |
| string/null | Tag color |
| array | GET parameter “with” is required. |
| object | Linked contact data |
| ints | Linked contact ID |
| bool | Defines whether the contact is main for the lead |
| array | Linked company data array. This array always consists of 1 element as a lead can have only 1 company linked to it. |
| object | Linked company data |
| int | Linked company ID |
| array | GET parameter “with” is required. |
| object | Linked list element data |
| int | Linked element ID |
| object | Meta-data of the element |
| int | Linked element quantity |
| int | ID of the linked element’s list |