List Emails
curl --request GET \
--url https://api.thepurplebox.io/v1/emails \
--header 'Authorization: Bearer <token>'{
"status": 200,
"message": "emails retrieved successfully.",
"data": {
"data": [
{
"id": "xxxxx",
"message_id": "xxxxx@me.thepurplebox.io",
"from_address": "hello@yourdomain.com",
"to_addresses": [
"user@example.com"
],
"subject": "Complete Your Sign-In to thePurpleBox",
"size": 8915,
"inline": 0,
"attachments": 0,
"api_key_id": 2,
"snippet": "Complete Your Sign-In Hey user@example.com, We noticed a sign-in attempt to your purplebox account...",
"created_at": "2025-11-21T10:51:55.330945Z",
"team_id": "xxxxx",
"metadata": {
"from": "hello@yourdomain.com",
"to": [
"user@example.com"
],
"cc": null,
"bcc": null,
"reply_to": null,
"text": "",
"html": ""
},
"opened_at": null,
"delivered_at": null,
"click_count": 0,
"status": "processing",
"credits_used": 1
}
],
"pagination": {
"page": 1,
"total_records": 11,
"total_pages": 2,
"limit": 10
}
}
}
Emails
List Emails
Retrieve a paginated list of all emails sent through your account.
GET
/
v1
/
emails
List Emails
curl --request GET \
--url https://api.thepurplebox.io/v1/emails \
--header 'Authorization: Bearer <token>'{
"status": 200,
"message": "emails retrieved successfully.",
"data": {
"data": [
{
"id": "xxxxx",
"message_id": "xxxxx@me.thepurplebox.io",
"from_address": "hello@yourdomain.com",
"to_addresses": [
"user@example.com"
],
"subject": "Complete Your Sign-In to thePurpleBox",
"size": 8915,
"inline": 0,
"attachments": 0,
"api_key_id": 2,
"snippet": "Complete Your Sign-In Hey user@example.com, We noticed a sign-in attempt to your purplebox account...",
"created_at": "2025-11-21T10:51:55.330945Z",
"team_id": "xxxxx",
"metadata": {
"from": "hello@yourdomain.com",
"to": [
"user@example.com"
],
"cc": null,
"bcc": null,
"reply_to": null,
"text": "",
"html": ""
},
"opened_at": null,
"delivered_at": null,
"click_count": 0,
"status": "processing",
"credits_used": 1
}
],
"pagination": {
"page": 1,
"total_records": 11,
"total_pages": 2,
"limit": 10
}
}
}
Headers
application/jsonQuery Parameters
Page number for pagination.
Number of emails to return per page.
Search query to filter emails by subject, recipient, or sender.
Filter emails created on or after this date (ISO 8601 format, e.g.,
2025-11-01T00:00:00Z).Filter emails created on or before this date (ISO 8601 format, e.g.,
2025-11-30T23:59:59Z).Filter by email status. Can be a single status or comma-separated list. Possible values:
processing, queued, delivered, failed, bounced, complaint.Filter emails sent using a specific API key ID.
Response
HTTP status code. Returns
200 when emails are retrieved successfully.A human-readable message describing the result of the operation.
Contains the paginated list of emails and pagination metadata.
Show properties
Show properties
Array of email objects. HTML and full metadata are not included in list view.
Show properties
Show properties
Unique identifier for the email.
The message ID used in email headers.
The sender email address.
Array of recipient email addresses.
The email subject line.
Total size of the email in bytes.
Number of inline attachments.
Number of file attachments.
ID of the API key used to send the email.
Text preview/snippet of the email content.
ISO 8601 timestamp when the email was created.
The team ID that owns this email.
Basic email metadata. HTML and text content are empty in list view.
Show properties
Show properties
Sender email address.
Array of recipient email addresses.
CC recipients, if any.
BCC recipients, if any.
Reply-to email address, if set.
Empty in list view. Use GET by ID to retrieve full content.
Empty in list view. Use GET by ID to retrieve full content.
ISO 8601 timestamp when the email was first opened. Null if not opened.
ISO 8601 timestamp when the email was delivered. Null if not yet delivered.
Number of times links in the email were clicked.
Current email status. Possible values:
processing, queued, delivered, failed, bounced, complaint.Number of credits consumed to send this email.
{
"status": 200,
"message": "emails retrieved successfully.",
"data": {
"data": [
{
"id": "xxxxx",
"message_id": "xxxxx@me.thepurplebox.io",
"from_address": "hello@yourdomain.com",
"to_addresses": [
"user@example.com"
],
"subject": "Complete Your Sign-In to thePurpleBox",
"size": 8915,
"inline": 0,
"attachments": 0,
"api_key_id": 2,
"snippet": "Complete Your Sign-In Hey user@example.com, We noticed a sign-in attempt to your purplebox account...",
"created_at": "2025-11-21T10:51:55.330945Z",
"team_id": "xxxxx",
"metadata": {
"from": "hello@yourdomain.com",
"to": [
"user@example.com"
],
"cc": null,
"bcc": null,
"reply_to": null,
"text": "",
"html": ""
},
"opened_at": null,
"delivered_at": null,
"click_count": 0,
"status": "processing",
"credits_used": 1
}
],
"pagination": {
"page": 1,
"total_records": 11,
"total_pages": 2,
"limit": 10
}
}
}
⌘I