Skip to content

List outbound emails

GET
/v1/emails

This org's outbound emails, newest first. Scoped server-side to source:email-out — emails also remain visible (collapsed to failed) in the general GET /v1/events; this is a more granular, dedicated view, not a fork of the store.

Authorizations

apiKey

Scoped API key. Scopes are readwriteadmin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Parameters

Query Parameters

status
Type
string
Valid values
"sending""delivered""bounced""complained""suppressed""failed""dlq"
since
Type
string
Format
"date-time"
until
Type
string
Format
"date-time"
cursor

Opaque pagination cursor; pass back next_cursor from the previous page.

Type
string
limit
Type
integer
Maximum
100
Default
50

Responses

A page of emails.

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"id": "evt_01JX9",
  
  
  
"from": "string",
  
  
  
"to": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"subject": "string",
  
  
  
"status": "string",
  
  
  
"created_at": "string"
  
  
}
  
],
  
"next_cursor": "string"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Emithook · a Finnoto product