get https://{subdomain}.kommo.com/api/v4/leads/unsorted
This method allows getting a list of the incoming leads in the account
Limitations
The method is available in accordance with the user’s rights.
Authorization type
OAuth 2.0 with Access Token/ Long-lived token
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
An example of the request
In the following example, we will get a single incoming lead list.
https://example.kommo.com/api/v4/leads/unsorted?filter[uid]=5af9dedb6f2c6a29eaac6ee37fc75ffbb66e139e4603bdd0e14e39d4b319
Response parameters
| Parameter | Data type | Description |
|---|---|---|
| uid | string | Incoming lead UID |
| source_uid | string | Incoming lead source UID. Generated by the integration |
| source_name | string | Incoming lead source name |
| category | string | Incoming lead category: sip, mail, chats, forms |
| pipeline_id | int | ID of the pipeline in which the incoming lead is located |
| created_at | int | The time and date the incoming lead was created in the format of Unix Timestamp |
| metadata | object | Incoming lead metadata. Each type has its own parameters. |
| account_id | int | Account ID in which the incoming lead is located |
| _embedded | object | Embedded entities data |
| _embedded[contacts] | array | Data related to the contact of the incoming lead. Always consists of one object |
| _embedded[contacts][0] | object | Contact model |
| _embedded[contacts][0][id] | int | Contact ID |
| _embedded[companies] | array | Data related to the company of the incoming lead. Always consists of one object |
| _embedded[companies][0] | object | Company model |
| _embedded[companies][0][id] | int | Company ID |
| _embedded[leads] | array | Data related to the lead to which the incoming lead is connected . Always consists of one object |
| _embedded[leads][0] | object | Lead model |
| _embedded[leads][0][id] | int | Lead ID |