GET/v1/email-eventsemails:read

List email events

Run a request

GET/v1/email-events

Base URL

Query

limit

cursor

updated_since

contact_id

sent_email_id

kind

Resolved URL

GEThttps://coldos.justgotwyrd.com/api/v1/email-events

Paste an API key in the bar at the top of the page to enable Execute.

Parameters

Query parameters

limitintegeroptionaldefault 50
Max items to return. 1-200.
cursorstringoptional
Opaque pagination cursor returned in the previous page's `next_cursor`.
updated_sinceiso8601optional
Only return rows whose `updated_at` is greater than the supplied timestamp.
contact_iduuidoptional
Filter by contact.
sent_email_idstringoptional
Filter by sent-email.
kindstringoptional
Event kind.
openclickreplybounceunsubscribecomplaint

Responses

400Invalid request — see `error.message`.
401Missing or invalid API key.
403Authenticated, but the key lacks the required scope.
404The referenced resource does not exist or is not visible to your key.
429Rate limit exceeded — see `Retry-After`.
500Unexpected server error. Safe to retry with idempotency-key.

Code samples

curl -X GET "https://coldos.justgotwyrd.com/api/v1/email-events" \
  -H "Authorization: Bearer $COLD_OS_API_KEY"

Response · 200

{
  "data": [
    {
      "id": "01HZS4V8B6P9Q1R2S3T4U5V6W7",
      "sent_email_id": "01HZS3RV6W7X8Y9Z0A1B2C3D4E",
      "contact_id": "c2a8a93a-2f1c-4c5b-8f3d-9c1e3a8b5d12",
      "kind": "open",
      "occurred_at": "2026-05-01T09:18:42.000+05:30",
      "user_agent": "Mozilla/5.0 (Macintosh; ...) Safari/605.1.15",
      "ip_address": "203.0.113.7"
    },
    {
      "id": "01HZS4V8B6P9Q1R2S3T4U5V6W7",
      "sent_email_id": "01HZS3RV6W7X8Y9Z0A1B2C3D4E",
      "contact_id": "c2a8a93a-2f1c-4c5b-8f3d-9c1e3a8b5d12",
      "kind": "open",
      "occurred_at": "2026-05-01T09:18:42.000+05:30",
      "user_agent": "Mozilla/5.0 (Macintosh; ...) Safari/605.1.15",
      "ip_address": "203.0.113.7"
    }
  ],
  "next_cursor": "eyJsYXN0X2lkIjoiYzJhOGE5M2EifQ==",
  "has_more": true
}

Was this page helpful?

Your vote stays in this browser. We'll use it to prioritise rewrites.