List 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": "[email protected]",
                "from_address": "[email protected]",
                "to_addresses": [
                    "[email protected]"
                ],
                "subject": "Complete Your Sign-In to thePurpleBox",
                "size": 8915,
                "inline": 0,
                "attachments": 0,
                "api_key_id": 2,
                "snippet": "Complete Your Sign-In Hey [email protected], We noticed a sign-in attempt to your purplebox account...",
                "created_at": "2025-11-21T10:51:55.330945Z",
                "team_id": "xxxxx",
                "metadata": {
                    "from": "[email protected]",
                    "to": [
                        "[email protected]"
                    ],
                    "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
        }
    }
}

GET

https://api.thepurplebox.io

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": "[email protected]",
                "from_address": "[email protected]",
                "to_addresses": [
                    "[email protected]"
                ],
                "subject": "Complete Your Sign-In to thePurpleBox",
                "size": 8915,
                "inline": 0,
                "attachments": 0,
                "api_key_id": 2,
                "snippet": "Complete Your Sign-In Hey [email protected], We noticed a sign-in attempt to your purplebox account...",
                "created_at": "2025-11-21T10:51:55.330945Z",
                "team_id": "xxxxx",
                "metadata": {
                    "from": "[email protected]",
                    "to": [
                        "[email protected]"
                    ],
                    "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

Content-Type

string

application/json

Query Parameters

page

number

default:"1"

Page number for pagination.

limit

number

default:"10"

Number of emails to return per page.

string

Search query to filter emails by subject, recipient, or sender.

start_date

string

Filter emails created on or after this date (ISO 8601 format, e.g., 2025-11-01T00:00:00Z).

end_date

string

Filter emails created on or before this date (ISO 8601 format, e.g., 2025-11-30T23:59:59Z).

statuses

string

Filter by email status. Can be a single status or comma-separated list. Possible values: processing, queued, delivered, failed, bounced, complaint.

api_key_id

number

Filter emails sent using a specific API key ID.

Response

status

number

HTTP status code. Returns 200 when emails are retrieved successfully.

message

string

A human-readable message describing the result of the operation.

data

object

Contains the paginated list of emails and pagination metadata.

Show properties

data

array

Array of email objects. HTML and full metadata are not included in list view.

Show properties

string

Unique identifier for the email.

message_id

string

The message ID used in email headers.

from_address

string

The sender email address.

to_addresses

array

Array of recipient email addresses.

subject

string

The email subject line.

size

number

Total size of the email in bytes.

inline

number

Number of inline attachments.

attachments

number

Number of file attachments.

api_key_id

number

ID of the API key used to send the email.

snippet

string

Text preview/snippet of the email content.

created_at

string

ISO 8601 timestamp when the email was created.

team_id

string

The team ID that owns this email.

metadata

object

Basic email metadata. HTML and text content are empty in list view.

Show properties

from

string

Sender email address.

array

Array of recipient email addresses.

array | null

CC recipients, if any.

bcc

array | null

BCC recipients, if any.

reply_to

string | null

Reply-to email address, if set.

text

string

Empty in list view. Use GET by ID to retrieve full content.

html

string

Empty in list view. Use GET by ID to retrieve full content.

opened_at

string | null

ISO 8601 timestamp when the email was first opened. Null if not opened.

delivered_at

string | null

ISO 8601 timestamp when the email was delivered. Null if not yet delivered.

click_count

number

Number of times links in the email were clicked.

status

string

Current email status. Possible values: processing, queued, delivered, failed, bounced, complaint.

credits_used

number

Number of credits consumed to send this email.

pagination

object

Pagination metadata.

Show properties

page

number

Current page number.

total_records

number

Total number of emails across all pages.

total_pages

number

Total number of pages available.

limit

number

Number of records per page.

{
    "status": 200,
    "message": "emails retrieved successfully.",
    "data": {
        "data": [
            {
                "id": "xxxxx",
                "message_id": "[email protected]",
                "from_address": "[email protected]",
                "to_addresses": [
                    "[email protected]"
                ],
                "subject": "Complete Your Sign-In to thePurpleBox",
                "size": 8915,
                "inline": 0,
                "attachments": 0,
                "api_key_id": 2,
                "snippet": "Complete Your Sign-In Hey [email protected], We noticed a sign-in attempt to your purplebox account...",
                "created_at": "2025-11-21T10:51:55.330945Z",
                "team_id": "xxxxx",
                "metadata": {
                    "from": "[email protected]",
                    "to": [
                        "[email protected]"
                    ],
                    "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
        }
    }
}

Send email Get Email by ID

⌘I

API Documentation

Transactional

Emails

Domains

API Keys

Headers

Query Parameters

Response

API Documentation

Transactional

Emails

Domains

API Keys

​Headers

​Query Parameters

​Response

Headers

Query Parameters

Response