Events list

get

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

This method allows getting the events list

Limitations
The method is available for all account users. The returned data depends on the user’s rights for the entity.

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

The method returns an array of event objects.

Parameter	Data type	Description
id	string	Event ID
type	string	Event type
entity_id	int	ID of the entity the event belongs to
entity_type	string	Type of the entity the event belongs to
created_by	int	ID of the user who created the event
created_at	int	Event creation date in the Unix Timestamp format
value_after	array	An array of the event changes.
value_before	array	An array of the event changes.
account_id	int	Account ID where the event is located in

`with` parameters

Parameter	Description
contact_name	If event belongs to a contact, you will receive the contact’s name as well as the ID in the response
lead_name	If event belongs to a lead, you will receive the lead’s name as well as the ID in the response
company_name	If event belongs to a company, you will receive the company’s name as well as the ID in the response
catalog_name	If event belongs to a list element, you will receive the list’s name as well as the ID in the response
catalog_element_name	If event belongs to a list element, you will receive the list’s name as well as the ID in the response

Query Params

with

string

This parameter takes a string which may consist of several values separated by commas. You can find them in the WITH table

page

int32

A page of the response data

limit

int32

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

filter[id]

string

Filter by the event ID. You can pass single or multiple ID divided by a comma.

filter[created_at][from]

int32

Filter by the event creation date. A timestamp can be passed, in that case, events created after the timestamp value will be returned.

filter[created_at][to]

int32

Filter by the event creation date. A timestamp can be passed, in that case, events created before the timestamp value will be returned.

filter[created_by]

string

Filter by users. An string of up to 10 users IDs divided by comma can be passed.

filter[entity]

string

Filter by the entity type passed as a string of entities divided by comma. Available parameters – lead, contact, company, task, catalog_{LIST_ID}.

filter[entity_id]

string

Filter by the entity ID. A string with up to 10 IDs divided by commas can be passed. Pass only one entity to filter[entity] to use this filter.

filter[type]

string

Filter by the event type. Types are passed as a string of types divided by commas. You can find event types here: https://developers.kommo.com/reference/events-types

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Response parameters

with parameters

200200

401401

402402

`with` parameters