Emails

List emails

Requires emails:r.

get/v1/emails

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/emails
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Query parameters

limitstring

1 to 100. Default 50.

cursorstring

next_cursor from the previous page.

statusstring

One of queued, scheduled, sending, sent, delivered, bounced, complained, rejected, failed, cancelled.

string
OR
string[]

name:value. Repeat to require several; all must match.

tostring

A full address in the email's to list (not cc or bcc), matched exactly whatever its case.

fromstring

The full sender address, matched exactly whatever its case.

sincestring

ISO 8601 date-time with an offset: created_at at or after this moment.

untilstring

ISO 8601 date-time with an offset: created_at at or before this moment.

domain_idstring

The sending domain's id (GET /v1/email-domains).

Response

A page of sent emails in the calling key's mode (a live key never lists a test send, nor a test key a live one), newest first.

has_moreboolean required
next_cursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.