Companies list

get

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

The method allows you to get a list of companies

Query Params

with

string

This parameter takes a string that may consist of several values separated by commas. See the table above.

page

int32

Page of response

limit

int32

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

query

string

Search query (will perform a search by custom fields values)

order[updated_at]

string

enum

List elements sorting by the time companies were updated at

Allowed:

order[id]

string

enum

List elements sorting by companies IDs

Allowed:

filter[id][]

array of int32s

Filter by company ID

filter[id][]

filter[name][]

array of strings

Filter by company name

filter[name][]

filter[created_by][]

array of int32s

Filter by ID of the user who added the company.

filter[created_by][]

filter[updated_by][]

array of int32s

Filter by ID of the user who updated the company last

filter[updated_by][]

filter[responsible_user_id][]

array of int32s

Filter by ID of the company responsible user

filter[responsible_user_id][]

filter[created_at][from]

int32

Filter by the creation date of the company in Unix Timestamp format. As a response you will get all the companies added after the date.

filter[created_at][to]

int32

Filter by the creation date of the company in Unix Timestamp format. As a response you will get all the companies added before the date.

filter[updated_at][from]

int32

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

filter[updated_at][to]

int32

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

filter[closest_task_at][from]

int32

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

filter[closest_task_at][to]

int32

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

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