Emails

Summarize email delivery per document

Summarize email delivery for a batch of documents in one call: emails sent, last status, last hand-off and failures per document.

  • last_status and last_sent_at describe the hand-off to the outgoing SMTP server, not real delivery.
  • A sent email may still bounce.
get/companies/{company}/emails/indicators

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/emails/indicators
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Query parameters

related_entity_ids[]string[] required

Public identifiers (UUID v7) of the documents to summarize, of any type, comma-separated or repeated (up to 100). Documents with no email, or not yours, are omitted from the response.

related_entity_type'invoice' | 'quote' | 'proforma' | 'delivery_note' | 'purchase_invoice' | 'recurring_invoice'

Optional document type that narrows the resolution of every id in the batch.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

EmailDeliveryIndicatorsV1Resource

Example response

{
  "data": [
    {
      "related_entity_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a9c",
      "related_entity_type": "invoice",
      "object": "email_delivery_indicator",
      "total": 2,
      "last_status": "sent",
      "last_sent_at": "2026-07-15T09:30:12+00:00",
      "attempts": 1
    }
  ]
}

Changes

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