Skip to main content
GET
/
emails
List sent emails
curl --request GET \
  --url https://api.arkhq.io/v1/emails \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "12345",
      "token": "<string>",
      "to": "[email protected]",
      "from": "<string>",
      "subject": "<string>",
      "status": "pending",
      "timestamp": 123,
      "timestampIso": "2023-11-07T05:31:56Z",
      "tag": "<string>"
    }
  ],
  "page": 1,
  "perPage": 30,
  "total": 150,
  "totalPages": 5,
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Query Parameters

​
status
enum<string>

Filter by delivery status:

  • pending - Email accepted, waiting to be processed
  • sent - Email transmitted to recipient's mail server
  • softfail - Temporary delivery failure, will retry
  • hardfail - Permanent delivery failure
  • bounced - Email bounced back
  • held - Held for manual review
Available options:
pending,
sent,
softfail,
hardfail,
bounced,
held
​
to
string<email>

Filter by recipient email address

​
from
string<email>

Filter by sender email address

​
tag
string

Filter by tag

​
after
string

Return emails sent after this timestamp (Unix seconds or ISO 8601)

​
before
string

Return emails sent before this timestamp

​
page
integer
default:1

Page number (starts at 1)

Required range: x >= 1
​
perPage
integer
default:30

Results per page (max 100)

Required range: 1 <= x <= 100

Response

List of emails

​
data
object[]
required

List of email summaries

​
page
integer
required

Current page number (1-indexed)

Example:

1

​
perPage
integer
required

Items per page

Example:

30

​
total
integer
required

Total number of items

Example:

150

​
totalPages
integer
required

Total number of pages

Example:

5

​
meta
object
required