Get entity's notes list

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

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

Language

Credentials

OAuth2

URL

Loading…

Response

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

application/json

200200

401401

402402