Get all notes

GET

https://api.brevo.com/v3/crm/notes

GET

/v3/crm/notes

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.notes.getAllNotes({});
}
main();

[
  {
    "text": "<p>Meeting notes: <b>Action item</b> - visit <a href=\"https://www.brevo.com/\">Brevo</a> for details.</p>",
    "id": "61a5cd07ca1347c82306ad09",
    "contactIds": [
      247,
      1,
      2
    ],
    "companyIds": [
      "61a5ce58c5d4795761045990",
      "61a5ce58c5d4795761045991"
    ],
    "dealIds": [
      "61a5ce58c5d4795761045990",
      "61a5ce58c5d4795761045991"
    ],
    "authorId": {
      "email": "johndoe@example.com",
      "id": "61a5ce58y5d4795761045991",
      "locale": "en_GB",
      "name": {
        "fullName": "John Doe"
      },
      "timezone": "Asia/Kolkata"
    },
    "createdAt": "2017-05-01T17:05:03.000Z",
    "updatedAt": "2017-05-01T17:05:03.000Z"
  }
]

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.

AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app's client_id/client_secret for a short-lived Bearer token.

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:  (paragraph),  /  (bold),  /  (italic),  (underline),   (line break), <a href="..."> (labelled hyperlink). Example labelled link: <a href="https://example.com">Link text</a>.

idstringOptional

Unique note Id

contactIdslist of integersOptional

Contact ids linked to a note

companyIdslist of stringsOptional

Company ids linked to a note

dealIdslist of stringsOptional

Deal ids linked to a note

authorIdobjectOptional

Account details of user which created the note

createdAtdatetimeOptional

Note created date/time

updatedAtdatetimeOptional

Note updated date/time

Errors

400

Bad Request Error