Get StartedVeriFactuStripeAPI Reference
Emails

Email indicators for related entities

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.

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

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

related_entity_idsarray<string>

Comma-separated list of related entity ids (e.g. invoice ids)

Response Body

application/json

application/json

application/json

curl -X GET "https://app.beel.es/api/v1/emails/indicators?related_entity_ids=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "success": true,
  "data": [
    {
      "related_entity_id": "e94907ff-519b-4a75-b3bc-05aaf47d6339",
      "count": 2,
      "last_status": "SENT",
      "last_sent_at": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "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"
  }
}

Get a sent email with its body GET

Retrieves a single sent email including its message body (HTML / plain text), fetched live from the email provider (Resend). The body is only available for emails that have a provider message id and while the provider still retains the message; otherwise `body_available` is `false` and the body fields are null. Subject to the same `(account, environment)` isolation and customer-facing allow-list as `GET /v1/emails`.

List sent emails GET

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).