beel_list_email_deliveries
Fetch email delivery history for an account, including queued and rejected messages. Filter by status, type, recipient, or entity to audit outbound communications.
Instructions
Returns the emails the system recorded on behalf of the account in the
path: invoice deliveries, verification, onboarding. Every attempt is
recorded, not only the ones that went out — an email stopped by policy is
listed with status REJECTED, and one accepted but not dispatched yet
as QUEUED, rather than being omitted.
Results are ordered by sent_at descending (configurable via sort_by /
sort_order) and can be narrowed by type, status, recipient and
related_entity_id. sent_at is the moment the message was handed over,
so it is absent while an email is still QUEUED. The account is the one
named in the path; the environment is not, and comes from the credential.
This operation only reads the history; it does not send or resend
anything.
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) |