Sales CRMNotes

Get all notes

Retrieve a paginated list of CRM notes with optional filtering by entity type, entity IDs, and date range. Results are sorted by creation date in descending order by default, with a default limit of 50 notes per page.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

entityenumOptional
Filter by note entity type
Allowed values:
entityIdsstringOptional
Filter by note entity IDs
dateFromintegerOptional

dateFrom to date range filter type (timestamp in milliseconds)

dateTointegerOptional

dateTo to date range filter type (timestamp in milliseconds)

offsetlongOptional
Index of the first document of the page
limitlongOptionalDefaults to 50
Number of documents per page
sortenumOptional

Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed

Allowed values:

Response

Returns notes list with filters
textstring1-10000 characters

Content of the note. Supports HTML for rich text formatting. Supported tags include: <p> (paragraph), <b> / <strong> (bold), <i> / <em> (italic), <u> (underline), <br /> (line break), <a href="..."> (labelled hyperlink). Example labelled link: <a href="https://example.com">Link text</a>.

idstring
Unique note Id
contactIdslist of integers
Contact ids linked to a note
companyIdslist of strings
Company ids linked to a note
dealIdslist of strings
Deal ids linked to a note
authorIdobject
Account details of user which created the note
createdAtdatetime

Note created date/time

updatedAtdatetime

Note updated date/time

Errors

400
Bad Request Error