Get all notes | Brevo API Documentation

1 import requests 2 3 url = "https://api.brevo.com/v3/crm/notes" 4 5 headers = {"api-key": "<apiKey>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 [ 2 { 3 "text": "In communication with client_dev for resolution of queries.", 4 "authorId": { 5 "email": "johndoe@example.com", 6 "id": "61a5ce58y5d4795761045991", 7 "locale": "en_GB", 8 "name": { 9 "fullName": "John Doe" 10 }, 11 "timezone": "Asia/Kolkata" 12 }, 13 "contactIds": [ 14 247, 15 1, 16 2 17 ], 18 "createdAt": "2017-05-01T17:05:03.000Z", 19 "dealIds": [ 20 "61a5ce58c5d4795761045990", 21 "61a5ce58c5d4795761045991" 22 ], 23 "id": "61a5cd07ca1347c82306ad09", 24 "updatedAt": "2017-05-01T17:05:03.000Z" 25 } 26 ]

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-3000 characters

Text content of a note

authorIdobject or null

Account details of user which created the note

contactIdslist of integers or null

Contact ids linked to a note

createdAtdatetime or null

Note created date/time

dealIdslist of strings or null

Deal ids linked to a note

idstring or null

Unique note Id

updatedAtdatetime or null

Note updated date/time

Authentication

Query parameters

Response

Errors