Get events | Brevo API Documentation

Retrieve a list of events filtered by various criteria.

Authentication

api-keystring

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

Query parameters

contact_idlist of longsOptional

Filter by contact ID (repeatable)

event_namelist of stringsOptional

Filter by event name (repeatable)

object_typelist of stringsOptional

Filter by object type (repeatable)

startDatestringOptional

Mandatory if endDate is used. Start of date range (YYYY-MM-DD or RFC3339). Defaults to 6 months ago when omitted alongside endDate. Must be ≤ endDate.

endDatestringOptional

Mandatory if startDate is used. End of date range (YYYY-MM-DD or RFC3339). Must be ≥ startDate.

limitintegerOptional1-10000Defaults to 100

Max events to return. Default 100, min 1, max 10000.

offsetintegerOptional>=0Defaults to 0

Events to skip for pagination. Default 0, min 0.

Response

List of events and total count for pagination

countlong

Total count of events matching the filters (use for pagination)

eventslist of objects or null

List of matching events ordered by event_date descending

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.event.getEvents({});
8	}
9	main();

1	{
2	"count": 2,
3	"events": [
4	{
5	"contact_id": 211,
6	"event_date": "2024-02-06T20:59:23.383Z",
7	"event_name": "order_created",
8	"event_filter_id": "abc123",
9	"source": "api",
10	"object_type": "subscription",
11	"event_properties": {
12	"duration": 142,
13	"video_title": "Brevo — The most approachable CRM suite"
14	},
15	"contact_properties": {
16	"AGE": 32,
17	"GENDER": "FEMALE"
18	}
19	}
20	]
21	}

Authentication

Query parameters

Response

Errors