Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Your Inbound API key. Include it in the Authorization header as: Bearer

Query Parameters

type
enum<string>
Available options:
all,
sent,
received,
scheduled
status
enum<string>
Available options:
all,
delivered,
pending,
failed,
bounced,
scheduled,
cancelled,
unread,
read,
archived
time_range
enum<string>
Available options:
1h,
24h,
7d,
30d,
90d,
all

Search query to filter emails by subject, sender, or recipient. Case-insensitive partial match.

domain
string

Filter by domain. Accepts domain ID (e.g., 'dom_xxx') or domain name (e.g., 'example.com').

address
string

Filter by email address. Accepts address ID (e.g., 'addr_xxx') or raw email address (e.g., 'user@example.com').

limit
string
default:50

Maximum number of emails to return (1-100). Default is 50.

offset
string
default:0

Number of emails to skip for pagination. Default is 0.

Response

Response for status 200

data
object[]
required

Array of email objects matching the query

pagination
object
required

Pagination metadata

filters
object
required

Applied filters for this query