v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Events list

This method allows getting the events list

get/api/v4/events

Query parameters

withstring

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

pageinteger

A page of the response data

limitinteger

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]integer

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]integer

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

Response

200