curl --request GET \
--url https://app.lettr.com/api/campaigns/{campaignId}/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.lettr.com/api/campaigns/{campaignId}/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.lettr.com/api/campaigns/{campaignId}/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.lettr.com/api/campaigns/{campaignId}/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.lettr.com/api/campaigns/{campaignId}/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.lettr.com/api/campaigns/{campaignId}/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.lettr.com/api/campaigns/{campaignId}/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "Campaign events retrieved successfully.",
"data": {
"events": [
{
"event_id": "92356829",
"event_type": "open",
"email": "jane@example.com",
"timestamp": "2026-05-01T12:30:00+00:00",
"bounce_class": "<string>",
"reason": "<string>",
"target_link_url": "<string>",
"user_agent": "<string>"
}
],
"next_cursor": "<string>"
}
}List campaign engagement events
Returns engagement events (opens, clicks, bounces, etc.) for a campaign, with optional filtering by type, recipient email, and date range. Uses cursor-based pagination: keep requesting with the returned next_cursor until it is null. When a filter is applied, a page may come back with an empty events array and a non-null next_cursor — that means more pages remain, not that there are no matching events, so continue paginating until next_cursor is null. Requires the campaigns:read scope.
curl --request GET \
--url https://app.lettr.com/api/campaigns/{campaignId}/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.lettr.com/api/campaigns/{campaignId}/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.lettr.com/api/campaigns/{campaignId}/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.lettr.com/api/campaigns/{campaignId}/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.lettr.com/api/campaigns/{campaignId}/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.lettr.com/api/campaigns/{campaignId}/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.lettr.com/api/campaigns/{campaignId}/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "Campaign events retrieved successfully.",
"data": {
"events": [
{
"event_id": "92356829",
"event_type": "open",
"email": "jane@example.com",
"timestamp": "2026-05-01T12:30:00+00:00",
"bounce_class": "<string>",
"reason": "<string>",
"target_link_url": "<string>",
"user_agent": "<string>"
}
],
"next_cursor": "<string>"
}
}next_cursor until it is null. When a filter is applied, a page may come back with an empty events array and a non-null next_cursor — that means more pages remain, not that there are no matching events, so continue paginating until next_cursor is null. Requires the campaigns:read scope.Authorizations
API key for authentication
Path Parameters
Campaign ID
Query Parameters
Filter by event type
injection, delivery, bounce, spam_complaint, open, click, list_unsubscribe Filter by recipient email
Only events at or after this time (ISO 8601). A date-only value (e.g. 2026-05-01) is treated as the start of that day in UTC.
Only events at or before this time (ISO 8601), inclusive. A date-only value (e.g. 2026-05-01) covers the whole of that day in UTC (through 23:59:59).
Max events per page (max 100)
1 <= x <= 100Pagination cursor from a previous response
Was this page helpful?