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