Events
List Events
Retrieve events with optional filters (name, customer/external customer, timeframe) and pagination ordered by most recent first.
Authorization
bearerAuth AuthorizationBearer <token>
Use your secret API key as the bearer token
In: header
Query Parameters
eventName?string
Filter by event name (case-sensitive).
customerId?string
Filter by internal customer ID.
Match
^cus_[A-Za-z0-9]{22}$extCustomerId?string
Filter by external customer identifier.
idempotencyKey?string
Filter by idempotency key (deduped over 24 hours).
startTime?string
Return events at or after this timestamp.
Format
date-timeendTime?string
Return events before this timestamp.
Format
date-timelimit?integer
Maximum events to return (default 50, max 200).
Default
50Range
1 <= value <= 200offset?integer
Number of records to skip for pagination.
Default
0Range
0 <= valueResponse Body
application/json
application/json
application/json
curl -X GET "https://api.getlumen.dev/v1/events"{
"events": [
{
"id": "evt_9fQ1r2s3t4u5v6w7x8y9z0",
"eventName": "api-call",
"customerId": "cus_Lo4xGg1Yk9pB2eWv3sNt",
"eventValue": 1,
"eventTimestamp": "2025-02-20T17:00:00.000Z",
"properties": {
"endpoint": "/v1/messages",
"status": 200
},
"idempotencyKey": "evt_12345",
"createdAt": "2025-02-20T17:00:01.000Z"
},
{
"id": "evt_c1d2e3f4g5h6i7j8k9l0m1",
"eventName": "user-login",
"extCustomerId": "user_ext_456",
"eventString": "user_ext_456",
"eventTimestamp": "2025-02-20T17:05:00.000Z",
"properties": {
"region": "us-east-1"
},
"idempotencyKey": "evt_67890",
"createdAt": "2025-02-20T17:05:01.000Z"
}
],
"pagination": {
"total": 2,
"limit": 50,
"offset": 0,
"hasMore": false
}
}{
"error": "Invalid filters",
"details": "endTime must be after startTime"
}{
"error": "Failed to fetch events"
}