List domain events
GET
/v1/email/domains/{domain_id}/events
curl -X GET "https://us1.platform.bird.com/v1/email/domains/{domain_id}/events" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=created_at" \
--url-query "order=desc" \
--url-query "limit=25"Returns configuration and verification events for a sending domain.
Parametri
domain_id
string
Domain ID.
Parametri di query
sort
string
Field to sort by.
order
string
Sort direction. Defaults to desc (newest/largest first).
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
Payload di risposta
data
array of object
obbligatorio
Page of domain events, newest first by default.
Mostra attributi secondari
data.id
string
obbligatorio
Event ID.
data.type
string
obbligatorio
Type of domain event. Open enum — new event types may be added over time, so treat any unrecognized value as a future event rather than an error. The values below are the types known at this version.
data.summary
string
obbligatorio
Human-readable summary of what changed.
data.metadata
object
obbligatorio
Structured details for the event.
data.created_at
string
obbligatorio
When the event was recorded.
next_cursor
nullable string
obbligatorio
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
obbligatorio
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
obbligatorio
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.