Emails

List sent emails

Retrieve a list of emails your workspace has sent or scheduled. Results are newest-first and cursor-paginated, and each row is a reference to a single email (status and lifecycle timestamps, not the rendered body). Narrow the list with the status, campaign_id, batch_id, and created_after/created_before filters. Use an email's id with Retrieve an email to read its full record, or Cancel or reschedule an email to change a scheduled send. For aggregate deliverability numbers over a window, see Email deliverability stats. Requires the emails:read capability.

get/email

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/email
  • Auth: HTTP bearer

Query parameters

limitinteger

Max rows to return (default 20, max 100).

afterstring

Return rows after this id (forward paging).

beforestring

Return rows before this id (backward paging).

status'scheduled' | 'queued' | 'sent' | 'delivered' | 'bounced' | 'complained' | 'canceled' | 'failed'

Filter by send status.

campaign_idstring

Only emails produced by this campaign's fan-out.

batch_idstring

Only emails sent as part of this batch.

created_afterstring

Only emails created at/after this ISO 8601 time.

created_beforestring

Only emails created at/before this ISO 8601 time.

Response

A page of emails.

object'list' required
has_moreboolean required

Changes

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