Lista de notas por tipo de entidade

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

Este método permite obter uma lista de notas pelo tipo de entidade

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

Parâmetro	Tipo de dado	Descrição
id	int	ID da Nota
entity_id	int	Note’s parent entity ID
created_by	int	ID do usuário que criou a nota
updated_by	int	ID do usuário que editou a nota por último
created_at	int	Data de criação da nota no formato Unix Timestamp
updated_at	int	Data de edição da nota no formato Unix Timestamp
responsible_user_id	int	ID do usuário responsável pela nota
group_id	int	ID do grupo do usuário responsável pela nota
note_type	string	Tipo de Nota
params	obj	Propriedades da Nota dependendo do seu tipo
account_id	int	ID da conta onde a nota está localizada

Path Params

entity_type

string

required

leads/contatos/empresas

Query Params

page

int32

Página de resposta

limit

int32

O número de entidades retornadas na resposta de uma solicitação (limite – 250)

filter[id][]

array of strings

Filtrar pelo ID da nota. Pode ser passado um único ID ou múltiplos IDs.

filter[id][]

filter[note_type][]

array of strings

Filtrar pelo tipo de nota. Podem ser passados múltiplos tipos de nota.

filter[note_type][]

filter[updated_at][from]

int32

Filtrar pela data de edição da nota. Um timestamp pode ser passado, e, nesse caso, serão retornadas notas editadas após o valor do timestamp.

filter[updated_at][to]

int32

Filtrar pela data de edição da nota. Um timestamp pode ser passado, e, nesse caso, serão retornadas notas editadas antes do valor do timestamp.

order[updated_at]

string

Ordenação dos elementos da lista.

order[id]

string

Ordenação dos elementos da lista.

Responses

Language

Credentials

OAuth2

URL


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

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

application/json

Parâmetros de resposta

200200

401401

402402