v1

latestOpenAPI 3.0.32026-07-132612241.2 MB
emails

get/emails/

Query parameters

accountstring

account

created_at__datestring date
created_at__date_or_isnullstring date
created_at__gtstring datetime
created_at__gt_or_isnullstring datetime
created_at__gtestring datetime
created_at__gte_or_isnullstring datetime
created_at__ltstring datetime
created_at__lt_or_isnullstring datetime
created_at__ltestring datetime
created_at__lte_or_isnullstring datetime
cursorinteger

The pagination cursor value.

external_idstring

external_id

external_id__icontainsstring

external_id__icontains

failed_at__datestring date
failed_at__date_or_isnullstring date
failed_at__gtstring datetime
failed_at__gt_or_isnullstring datetime
failed_at__gtestring datetime
failed_at__gte_or_isnullstring datetime
failed_at__ltstring datetime
failed_at__lt_or_isnullstring datetime
failed_at__ltestring datetime
failed_at__lte_or_isnullstring datetime
format'json' | 'xlsx'
from_emailstring

from_email

from_email__icontainsstring

from_email__icontains

idstring

id

messagestring

message

message__icontainsstring

message__icontains

orderingstring

Which field to use when ordering the results.

page_sizeinteger

Number of results to return per page.

received_at__datestring date
received_at__date_or_isnullstring date
received_at__gtstring datetime
received_at__gt_or_isnullstring datetime
received_at__gtestring datetime
received_at__gte_or_isnullstring datetime
received_at__ltstring datetime
received_at__lt_or_isnullstring datetime
received_at__ltestring datetime
received_at__lte_or_isnullstring datetime
reply_to_emailstring

reply_to_email

reply_to_email__icontainsstring

reply_to_email__icontains

searchstring

A search term.

sent_at__datestring date
sent_at__date_or_isnullstring date
sent_at__gtstring datetime
sent_at__gt_or_isnullstring datetime
sent_at__gtestring datetime
sent_at__gte_or_isnullstring datetime
sent_at__ltstring datetime
sent_at__lt_or_isnullstring datetime
sent_at__ltestring datetime
sent_at__lte_or_isnullstring datetime
state'queued' | 'over_quota' | 'sent' | 'failed' | 'received'

state

state__instring

state__in

subjectstring

subject

subject__icontainsstring

subject__icontains

updated_at__datestring date
updated_at__date_or_isnullstring date
updated_at__gtstring datetime
updated_at__gt_or_isnullstring datetime
updated_at__gtestring datetime
updated_at__gte_or_isnullstring datetime
updated_at__ltstring datetime
updated_at__lt_or_isnullstring datetime
updated_at__ltestring datetime
updated_at__lte_or_isnullstring datetime