Contacts list

get

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

This method allows to get a list of contacts in the account

Query Params

with

string

This parameter takes a string which may consist of several values separated by commas.

page

int32

Sample page

limit

int32

The number of the entities returned in the response of one request (limit – 250)

query

string

String or integer. Search query will perform a search by custom fields values.

order[updated_at]

string

enum

List elements sorting

Allowed:

order[id]

string

enum

List elements sorting

Allowed:

filter[id][]

array of int32s

Filter by contact ID

filter[id][]

filter[name][]

array of strings

Filter by contact name

filter[name][]

filter[created_by][]

array of int32s

Filter by ID of the user who added the contact(s).

filter[created_by][]

filter[updated_by][]

array of int32s

Filter by ID of the user who updated the contact last.

filter[updated_by][]

filter[responsible_user_id][]

array of int32s

Filter by ID of the contact responsible user

filter[responsible_user_id][]

filter[updated_at][from]

int32

Filter by the date in Unix Timestamp format when the contact was updated. As a response you will get all the contacts updated after the date.

filter[updated_at][to]

int32

Filter by the date in Unix Timestamp format when the contact was updated. As a response you will get all the contacts updated before the date.

filter[closest_task_at][from]

int32

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

filter[closest_task_at][to]

int32

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

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

401401