v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

Notes

Get all notes

get/crm/notes

Query parameters

entity'companies' | 'deals' | 'contacts'

Filter by note entity type

entityIdsstring

Filter by note entity IDs

dateFrominteger

dateFrom to date range filter type (timestamp in milliseconds)

dateTointeger

dateTo to date range filter type (timestamp in milliseconds)

offsetinteger

Index of the first document of the page

limitinteger

Number of documents per page

sort'asc' | 'desc'

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

Response

Returns notes list with filters

idstring

Unique note Id

textstring required

Text content of a note

contactIdsinteger[]

Contact ids linked to a note

dealIdsstring[]

Deal ids linked to a note

authorIdobject

Account details of user which created the note

createdAtstring date-time

Note created date/time

updatedAtstring date-time

Note updated date/time

Example response

[
  {
    "createdAt": "2017-05-01T17:05:03.000Z",
    "id": "61a5cd07ca1347c82306ad09",
    "text": "In communication with client for resolution of queries.",
    "authorId": {
      "id": "61a5ce58y5d4795761045991",
      "email": "johndoe@example.com",
      "locale": "en_GB",
      "timezone": "Asia/Kolkata",
      "name": {
        "fullName": "John Doe"
      }
    },
    "dealIds": [
      "61a5ce58c5d4795761045990",
      "61a5ce58c5d4795761045991"
    ],
    "contactIds": [
      247,
      1,
      2
    ],
    "updatedAt": "2017-05-01T17:05:03.000Z"
  }
]