Get a note | Brevo API Documentation

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.notes.getANote("id");
}
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 the full details of a single CRM note by its identifier. The response includes the note''s text content, creation date, author, and any associated contacts, companies, or deals.

Authentication

api-keystring

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

Path parameters

idstringRequired

Note ID to get

Response

Returns the Note by id

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>.

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

404

Not Found Error