Transactional Emails

List recipients of a single transactional email

One row per actual recipient - who received it, how many times they opened/clicked, and whether they bounced/complained/unsubscribed/paused/subscribed/resubscribed as a result of this specific send. Supports the usual filter[<field>] exact-match filtering (e.g. filter[unsubscribed]=true, filter[status]=failed), plus two convenience filters not tied to a literal field: filter[opened]=true/false and filter[clicked]=true/false.

get/v1/projectId/{projectId}/transactional-emails/{id}/recipients

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/transactional-emails/{id}/recipients
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

idstring required

The transactional email _id.

Query parameters

limitinteger

Max items per page. Capped at 30.

skipinteger

Number of items to skip, for pagination.

sort'sentAt' | 'createdAt' | 'email'

Field to sort by.

order'asc' | 'desc'
filter[<field>]string

Exact-match filter on a top-level field, e.g. filter[name]=Welcome. Repeatable for multiple fields.

Response

OK

statusinteger

Example response

{
  "status": 200
}

Changes

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