Get notes list of entity

get

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

This method allows getting a notes list by the ID of the parent entity

Limitations
The method is available for all account users. The returned data depends on the user’s rights for the entity.

Data type header when the request is successful
Content-Type: application/hal+json

Data type header in case of an error
Content-Type: application/problem+json

Response parameters

The method returns an array of note objects.

Parameter	Data type	Description
id	int	Note ID
entity_id	int	Note’s parent entity ID
created_by	int	ID of the user who created the note
updated_by	int	ID of the user who edited the note last
created_at	int	Note creation date in the format of Unix Timestamp
updated_at	int	Note edit date in the format of Unix Timestamp
responsible_user_id	int	Note responsible user ID
group_id	int	Group ID of the note responsible user
note_type	string	Note type
params	obj	Note properties depending on the note type.
account_id	int	Account ID where the note is located in
is_pinned	bool	The GET parameter `with` is required. Defines if the note is pinned in the entity card

Path Params

entity_type

string

required

leads/contacts/companies

entity_id

int32

required

ID of the entity

Query Params

page

int32

A page of theresponse

limit

int32

The number of the entities returned in the response of one request (limit – 250)

filter[id][]

array of strings

Filter by the note ID. Either a single ID or multiple IDs can be passed

filter[id][]

filter[note_type][]

array of strings

Filter by the note type. Multiple note types can be passed

filter[note_type][]

filter[updated_at][from]

int32

Filter by the note edit date. A timestamp can be passed, in that case, notes edited after the timestamp value will be returned.

filter[updated_at][to]

int32

Filter by the note edit date. A timestamp can be passed, in that case, notes edited before the timestamp value will be returned.

order[updated_at]

string

enum

List elements sorting

Allowed:

order[id]

string

enum

List elements sorting

Allowed:

with

string

enum

The parameter accepts a string. This method only supports the is_pinned value

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

401401

402402