> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.brevo.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.brevo.com/_mcp/server. # Get events GET https://api.brevo.com/v3/events This endpoint currently only supports custom events. Retrieve a list of events filtered by various criteria. Reference: https://developers.brevo.com/reference/get-events ## Authentication - `api-key` header (required) — The API key should be passed in the request headers as `api-key` for authentication. ## Request ### Query parameters - `contact_id` (list of long, optional) — Filter by contact ID (repeatable) - `event_name` (list of string, optional) — Filter by event name (repeatable) - `object_type` (list of string, optional) — Filter by object type (repeatable) - `startDate` (string, optional) — 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. - `endDate` (string, optional) — Mandatory if startDate is used. End of date range (YYYY-MM-DD or RFC3339). Must be ≥ startDate. - `limit` (integer, optional, default: 100) — Max events to return. Default 100, min 1, max 10000. - `offset` (integer, optional, default: 0) — Events to skip for pagination. Default 0, min 0. ## Response ### 200 List of events and total count for pagination - `count` (long, required) — Total count of events matching the filters (use for pagination) - `events` (list of object, optional) — List of matching events ordered by event_date descending - `contact_id` (long, optional) — Contact ID associated with the event - `event_date` (datetime, optional) — Date and time of the event - `event_name` (string, optional) — Name of the event - `event_filter_id` (string, optional) — Filter ID of the event - `object_type` (string, optional) — Object type associated with the event - `event_properties` (map from string to any, optional) — Event-level custom properties - `contact_properties` (map from string to any, optional) — Contact-level properties at time of event ## Errors ### 400 Bad Request Error bad request - `code` (enum, required) — Error code displayed in case of a failure - Allowed values: `invalid_parameter`, `missing_parameter`, `out_of_range`, `campaign_processing`, `campaign_sent`, `document_not_found`, `not_enough_credits`, `permission_denied`, `duplicate_parameter`, `duplicate_request`, `method_not_allowed`, `unauthorized`, `account_under_validation`, `not_acceptable`, `bad_request`, `unprocessable_entity`, `Domain does not exist`, `Contact email not found`, `Attribute not found`, `Category id not found`, `Invalid parameters passed`, `Record(s) for identifier not found`, `Returned when query params are invalid`, `Returned when invalid data posted`, `Feed not found`, `Campaign ID not found`, `api-key not found`, `DMARC policy requires domain authentication`, `DNS records not properly configured`, `Invalid OTP code provided`, `OTP code has expired`, `Domain already exists in your account`, `The sum of all IP weights must equal 100`, `Authentication failed`, `Insufficient credits`, `Request already processed` - `message` (string, required) — Readable message associated to the failure ### 401 Unauthorized Error bad request - `code` (enum, required) — Error code displayed in case of a failure - Allowed values: `invalid_parameter`, `missing_parameter`, `out_of_range`, `campaign_processing`, `campaign_sent`, `document_not_found`, `not_enough_credits`, `permission_denied`, `duplicate_parameter`, `duplicate_request`, `method_not_allowed`, `unauthorized`, `account_under_validation`, `not_acceptable`, `bad_request`, `unprocessable_entity`, `Domain does not exist`, `Contact email not found`, `Attribute not found`, `Category id not found`, `Invalid parameters passed`, `Record(s) for identifier not found`, `Returned when query params are invalid`, `Returned when invalid data posted`, `Feed not found`, `Campaign ID not found`, `api-key not found`, `DMARC policy requires domain authentication`, `DNS records not properly configured`, `Invalid OTP code provided`, `OTP code has expired`, `Domain already exists in your account`, `The sum of all IP weights must equal 100`, `Authentication failed`, `Insufficient credits`, `Request already processed` - `message` (string, required) — Readable message associated to the failure ### 500 Internal Server Error bad request - `code` (enum, required) — Error code displayed in case of a failure - Allowed values: `invalid_parameter`, `missing_parameter`, `out_of_range`, `campaign_processing`, `campaign_sent`, `document_not_found`, `not_enough_credits`, `permission_denied`, `duplicate_parameter`, `duplicate_request`, `method_not_allowed`, `unauthorized`, `account_under_validation`, `not_acceptable`, `bad_request`, `unprocessable_entity`, `Domain does not exist`, `Contact email not found`, `Attribute not found`, `Category id not found`, `Invalid parameters passed`, `Record(s) for identifier not found`, `Returned when query params are invalid`, `Returned when invalid data posted`, `Feed not found`, `Campaign ID not found`, `api-key not found`, `DMARC policy requires domain authentication`, `DNS records not properly configured`, `Invalid OTP code provided`, `OTP code has expired`, `Domain already exists in your account`, `The sum of all IP weights must equal 100`, `Authentication failed`, `Insufficient credits`, `Request already processed` - `message` (string, required) — Readable message associated to the failure ## Examples **Response** ```json { "count": 2, "events": [ { "contact_id": 211, "event_date": "2024-02-06T20:59:23.383Z", "event_name": "order_created", "event_filter_id": "abc123", "object_type": "subscription", "event_properties": { "duration": 142, "video_title": "Brevo — The most approachable CRM suite" }, "contact_properties": { "AGE": 32, "GENDER": "FEMALE" } } ] } ``` **SDK Code** ```typescript Event_getEvents_example import { BrevoClient } from "@getbrevo/brevo"; async function main() { const client = new BrevoClient({ apiKey: "YOUR_API_KEY_HERE", }); await client.event.getEvents({}); } main(); ``` ```python Event_getEvents_example from brevo import Brevo client = Brevo( api_key="YOUR_API_KEY_HERE", ) client.event.get_events() ``` ```php Event_getEvents_example event->getEvents( new GetEventsRequest([]), ); ``` ```go Event_getEvents_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.brevo.com/v3/events" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("api-key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Event_getEvents_example require 'uri' require 'net/http' url = URI("https://api.brevo.com/v3/events") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["api-key"] = '' response = http.request(request) puts response.read_body ``` ```java Event_getEvents_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.brevo.com/v3/events") .header("api-key", "") .asString(); ``` ```csharp Event_getEvents_example using RestSharp; var client = new RestClient("https://api.brevo.com/v3/events"); var request = new RestRequest(Method.GET); request.AddHeader("api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift Event_getEvents_example import Foundation let headers = ["api-key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.brevo.com/v3/events")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```