beel_list_email_deliveries
Review recorded email deliveries for your account—invoices, verification, onboarding—and filter by status, type, recipient, or related entity to trace every attempt.
Instructions
Returns the emails the system recorded on behalf of the account in the path: invoice deliveries, verification, onboarding. It only reads the history; it does not send or resend anything.
Every attempt is recorded, not only the ones that went out: an email stopped by policy is listed with
statusREJECTED, and one accepted but not dispatched yet asQUEUED, rather than being omitted.Order: by
sent_atdescending, configurable withsort_by/sort_order.Filters:
type,status,recipientandrelated_entity_id.sent_at: the moment the message was handed over, so it is absent while an email is stillQUEUED.Scope: the account is the one named in the path; the environment is not, and comes from the credential.
Endpoint: GET /v1/accounts/{account_id}/emails
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. The response echoes it back as `pagination.current_page`. | |
| type | No | Filter by email type (e.g. INVOICE_EMITTED) | |
| limit | No | How many items to return per page. The response echoes it back as `pagination.items_per_page`. | |
| status | No | Filter by delivery status | |
| sort_by | No | Field to sort by | sent_at |
| recipient | No | Filter to emails where any recipient contains the term (case-insensitive) | |
| account_id | Yes | Your own account, or an account you provisioned. It — not the credential — decides which account the operation acts on; a `403` is returned when you do not reach it, the same response an account that does not exist gets. | |
| sort_order | No | Sort order direction | desc |
| related_entity_id | No | Filter to emails associated with a given related entity (e.g. an invoice id) |