Get a note

GET

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

GET

/v3/crm/notes/:id

1 import { BrevoClient } from "@getbrevo/brevo";
2 
3 async function main() {
4     const client = new BrevoClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.notes.getANote("id");
8 }
9 main();

1 {
2   "text": "<p>Meeting notes: <b>Action item</b> - visit <a href=\"https://www.brevo.com/\">Brevo</a> for details.</p>",
3   "id": "61a5cd07ca1347c82306ad09",
4   "contactIds": [
5     247,
6     1,
7     2
8   ],
9   "companyIds": [
10     "61a5ce58c5d4795761045990",
11     "61a5ce58c5d4795761045991"
12   ],
13   "dealIds": [
14     "61a5ce58c5d4795761045990",
15     "61a5ce58c5d4795761045991"
16   ],
17   "authorId": {
18     "email": "johndoe@example.com",
19     "id": "61a5ce58y5d4795761045991",
20     "locale": "en_GB",
21     "name": {
22       "fullName": "John Doe"
23     },
24     "timezone": "Asia/Kolkata"
25   },
26   "createdAt": "2017-05-01T17:05:03.000Z",
27   "updatedAt": "2017-05-01T17:05:03.000Z"
28 }

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

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

404

Not Found Error