Leads list

get

https://{subdomain}.kommo.com/api/v4/leads

This method allows getting a list of leads in the account

Query Params

with

string

This parameter accepts a string which may consist of several values (look at the table above) separated by commas.

page

int32

Page of leads list

limit

string

The number of entities returned per request (limit – 250)

query

string

Search query (Searches through the filled fields of the entity)

order[created_at]

string

enum

Sorting the results

Allowed:

order[updated_at]

string

enum

Sorting the results

Allowed:

order[id]

string

enum

Sorting the results

Allowed:

filter[id][]

array of int32s

Filter by lead ID

filter[id][]

filter[name][]

array of strings

Filter by lead name

filter[name][]

filter[price]

int32

filter[created_by][]

array of int32s

Filter by ID of the user who created the entity.

filter[created_by][]

filter[updated_by][]

array of int32s

Filter by ID of the user who changed the entity last

filter[updated_by][]

filter[responsible_user_id][]

array of int32s

Filter by ID of the entity responsible user

filter[responsible_user_id][]

filter[created_at][from]

int32

Filter by the creation date of the lead. Date in Unix Timestamp format

filter[created_at][to]

int32

Filter by the creation date of the lead. Date in Unix Timestamp format

filter[updated_at][from]

int32

Filter by the last update date of the lead. Date in Unix Timestamp format.

filter[updated_at][to]

int32

Filter by the last update date of the lead. Date in Unix Timestamp format.

filter[closed_at][from]

int32

Filter by the lead closing date. Date in Unix Timestamp format.

filter[closed_at][to]

int32

Filter by the lead closing date. Date in Unix Timestamp format.

filter[closest_task_at][from]

int32

Filter leads by the date of the task closest to completion. Date in Unix Timestamp format.

filter[closest_task_at][to]

int32

Date in Unix Timestamp format. Date in Unix Timestamp format.

filter[pipeline_id][]

array of int32s

Filter by pipeline ID

filter[pipeline_id][]

filter[statuses][0][pipeline_id]

int32

Should be used with filter[statuses][0][status_id]. The filter allows you to filter leads based on their specific stages.

filter[statuses][0][status_id]

int32

Should be used with filter[statuses][0][pipeline_id]. The filter allows you to filter leads based on their specific stages.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

204204

400400

401401

403403

429429

500500