v1

latestOpenAPI 3.1.02026-07-261620662.2 KB

Lista de eventos

Este método permite obter a lista de eventos.

get/api/v4/events

Query parameters

withstring

Este parâmetro recebe uma string que pode consistir em vários valores separados por vírgulas. Você pode encontrá-los na tabela WITH.

pageinteger

Uma página dos dados de resposta.

limitinteger

Número de entidades retornadas por solicitação (limite – 250)

filter[id]string

Filtrar pelo ID do evento. Você pode passar um único ID ou vários IDs separados por vírgula.

filter[created_at][from]integer

Filtrar pela data de criação do evento. Um timestamp pode ser passado; nesse caso, eventos criados após o valor do timestamp serão retornados.

filter[created_at][to]integer

Filtrar pela data de criação do evento. Um timestamp pode ser passado; nesse caso, eventos criados antes do valor do timestamp serão retornados.

filter[created_by]string

Filtrar por usuários. Uma string de até 10 IDs de usuários separados por vírgula pode ser passada.

filter[entity]string

Filtrar pelo tipo de entidade, passado como uma string de entidades separadas por vírgula. Parâmetros disponíveis – lead, contact, company, task, catalog_{LIST_ID}.

filter[entity_id]string

Filtrar pelo ID da entidade. Uma string com até 10 IDs separados por vírgula pode ser passada. Passe apenas uma entidade para filter[entity] para usar este filtro.

filter[type]string

Filtrar pelo tipo de evento. Os tipos são passados como uma string de tipos separados por vírgula. Você pode encontrar os tipos de eventos aqui: https://developers.kommo.com/reference/events-types

Response

200