v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Get notes list of entity

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

get/api/v4/{entity_type}/{entity_id}/notes

entity_typestring required

leads/contacts/companies

entity_idinteger required

ID of the entity

pageinteger

A page of theresponse

limitinteger

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

filter[id][]string[]

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

filter[note_type][]string[]

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

filter[updated_at][from]integer

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

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]'asc' | 'desc'

List elements sorting

order[id]'asc' | 'desc'

List elements sorting

with'is_pinned'

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

200