Lista de eventos

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

Este método permite obter a lista de eventos.

Limitações
O método está disponível para todos os usuários da conta. Os dados retornados dependem dos direitos do usuário para a entidade.

Cabeçalho de tipo de dado quando a solicitação é bem-sucedida
Content-Type: application/hal+json

Cabeçalho de tipo de dado em caso de erro
Content-Type: application/problem+json

Parâmetros de resposta

O método retorna um array de objetos de evento.

Parâmetro	Tipo de dado	Descrição
id	string	ID do evento
type	string	Tipo do evento
entity_id	int	ID da entidade à qual o evento pertence
entity_type	string	Tipo da entidade à qual o evento pertence
created_by	int	ID do usuário que criou o evento
created_at	int	Data de criação do evento no formato Unix Timestamp
value_after	array	Um array das mudanças do evento.
value_before	array	Um array das mudanças do evento.
account_id	int	ID da conta onde o evento está localizado

Parâmetros `with`

Parâmetro	Descriçao
contact_name	Se o evento pertence a um contato, você receberá o nome do contato, bem como o ID na resposta
lead_name	Se o evento pertence a um lead, você receberá o nome do lead, bem como o ID na resposta
company_name	Se o evento pertence a uma empresa, você receberá o nome da empresa, bem como o ID na resposta
catalog_name	Se o evento pertence a um elemento de lista, você receberá o nome da lista, bem como o ID na resposta
catalog_element_name	Se o evento pertence a um elemento de lista, você receberá o nome da lista, bem como o ID na resposta

Query Params

with

string

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

page

int32

Uma página dos dados de resposta.

limit

int32

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]

int32

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]

int32

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

Responses

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://subdomain.kommo.com/api/v4/events \
3
     --header 'accept: application/json'

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

application/json