Emails

Get the email indicators of several entities

Returns, for each related entity id given, how many emails the history holds for it, the status of the most recent one and when it was sent. Lets you show the state of an entity's email without loading its full history.

  • last_status: carries whatever the latest attempt ended in, REJECTED and QUEUED included, so a count above zero does not mean an email reached anyone.
  • Ids with no associated emails: omitted from the response rather than returned with count 0.
  • Deprecated: use GET /v1/accounts/{account_id}/email-indicators, which behaves identically. The successor is a sibling of the email collection, not …/emails/indicators: indicators used to sit where an email id goes.

Retires on 9 December 2026. See the migration guide for what moved where and what changes when you switch.

get/v1/emails/indicators

Request

  • Base URL: https://app.beel.es/api
  • URL: https://app.beel.es/api/v1/emails/indicators
  • Auth: HTTP bearer

Query parameters

related_entity_idsstring[] required

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

Response

Indicators retrieved successfully

successboolean required

Example response

{
  "success": true,
  "data": {
    "indicators": [
      {
        "count": 2
      }
    ]
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.