Get StartedVeriFactuStripeAPI Reference
Emails

List sent emails

Retrieves the history of emails the system has sent on behalf of the authenticated account (invoices, verification, onboarding, etc.).

Results are ordered by send date descending (configurable via sort_by / sort_order) and can be filtered by email type, delivery status and/or recipient.

The list is isolated by (account, environment). With an API key the environment is derived from the key prefix (beel_sk_live_* = production, beel_sk_test_* = sandbox); with a session cookie it follows the active environment (X-Environment header).

Try this endpoint with Claude
Copy the prompt for any assistant, or open it directly in Claude Code (needs it installed).
GET
/v1/emails

Authorization

AuthorizationBearer <token>

API Key authentication.

Format: Authorization: Bearer beel_sk_<key>

Scopes: API Keys use the same scopes as OAuth2 tokens. Each key is created with specific scopes that limit which endpoints it can access. The required scope for each endpoint is documented in the operation's security section under OAuth2.

Obtaining Keys: API Keys are managed from the BeeL dashboard

Security: API Keys are secret credentials. Do not share them or store them in source code

In: header

Query Parameters

page?integer

Page number (starts at 1)

Default1
Range1 <= value
limit?integer

Number of items per page

Default20
Range1 <= value <= 100
type?string

Filter by email type (e.g. INVOICE_EMITTED)

status?string

Filter by delivery status

Value in"SENT" | "FAILED" | "DELIVERED" | "BOUNCED" | "OPENED"
recipient?string

Filter to emails where any recipient contains the term (case-insensitive)

related_entity_id?string

Filter to emails associated with a given related entity (e.g. an invoice id)

Formatuuid
sort_by?string

Field to sort by

Default"sent_at"
Value in"sent_at" | "status" | "email_type"
sort_order?string

Sort order direction

Default"desc"
Value in"asc" | "desc"

Response Body

application/json

application/json

application/json

curl -X GET "https://app.beel.es/api/v1/emails"
{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email_type": "INVOICE_EMITTED",
      "recipients": [
        "cliente@ejemplo.com"
      ],
      "cc": [],
      "subject": "Factura 2025/0001",
      "related_entity_type": "FACTURA",
      "related_entity_id": "660e8400-e29b-41d4-a716-446655440111",
      "status": "SENT",
      "sent_at": "2025-01-20T14:30:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "items_per_page": 20,
    "total_items": 1,
    "total_pages": 1,
    "has_next": false,
    "has_previous": false
  },
  "meta": {
    "timestamp": "2025-01-20T15:00:00Z",
    "requestId": "req_123"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Email indicators for related entities GET

Returns, for each of the given related entity ids, a summary of the emails the system has sent that are associated with it: how many, the most recent status and when. Lets a UI light up an "email sent" badge next to each invoice without loading the full email history. Ids with no associated emails are simply omitted from the response. The same `(account, environment)` isolation and customer-facing allow-list as `GET /v1/emails` apply.

Get an API request log detail GET

Devuelve el detalle completo (cuerpos y cabeceras) de una petición concreta del usuario autenticado. 404 si no existe o no pertenece al usuario.