Developers
Reports

List email bounces

GET/reports/email-bounces

Returns user email addresses that bounced, were dropped, were reported as spam, or were deferred. Results are paginated with a cursor.

By default, only email bounces that have not been ignored are returned. Set ignored=true to list ignored email bounces instead.

The email field is included only when the credentials also have the users.read_personal permission.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
cursor?string
sort?string

Value in

  • "id"
  • "-id"
ignored?boolean

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/reports/email-bounces"
{  "data": [    {      "email": "string",      "id": "string",      "ignored": true,      "kind": "bounced",      "last_bounce_at": "2019-08-24T14:15:22Z",      "object": "email_bounce",      "revision": "string",      "user_id": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

List certificate issuance by product GET

Returns the number of certificates issued for each product. This report contains aggregate counts only and does not identify individual users. Certificates issued to a specific user are available through the certificates endpoints, which require their own permissions.

Ignore an email bounce PATCH

Marks an email bounce as ignored so the user's address can receive email from the account again. Requires the `email_bounces.ignore` permission. The only accepted value is `ignored: true`. This change cannot be reverted through the API. To make the update conditional, send an `If-Match` header built from the bounce's `revision` field, in the format `W/"email_bounce:<bounce_id>:<revision>"`. If the bounce has changed since that revision, the update is rejected.