beel-es · Schema

EmailDeliveryDetailResponse

InvoicingSpainFintechSoftware-as-a-Service

Properties

Name Type Description
success boolean
data object
meta object
View JSON Schema on GitHub

JSON Schema

beel-es-email-delivery-detail-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/beel-es/json-schema/beel-es-email-delivery-detail-response-schema.json",
  "title": "EmailDeliveryDetailResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/beel-es-accountemails-api-openapi.yml#/components/schemas/EmailDeliveryDetailResponse",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "$ref": "#/$defs/EmailDeliveryDetail"
    },
    "meta": {
      "$ref": "#/$defs/ResponseMeta"
    }
  },
  "$defs": {
    "EmailAttachment": {
      "type": "object",
      "description": "Attachment of a delivered email, retrieved from the provider.",
      "required": [
        "filename"
      ],
      "properties": {
        "filename": {
          "type": "string",
          "description": "File name"
        },
        "content_type": {
          "type": "string",
          "description": "MIME type of the attachment"
        },
        "size": {
          "type": "integer",
          "description": "Size in bytes, if known"
        },
        "download_url": {
          "type": [
            "string",
            "null"
          ],
          "description": "Temporary download URL signed by the provider (may expire). Null\nif the provider does not supply it.\n"
        }
      }
    },
    "EmailDeliveryDetail": {
      "type": "object",
      "description": "Detail of one recorded email, including the message content\n(HTML / text body) retrieved live from the email provider.\n\nThe body is only available for emails with a provider id\n(`external_message_id`) and while the provider retains it; when it\ncannot be retrieved, `body_available` is `false` and the bodies are null.\n",
      "required": [
        "id",
        "email_type",
        "recipients",
        "status",
        "body_available"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "email_type": {
          "type": "string",
          "description": "Email type (EmailType name or template). e.g. INVOICE_EMITTED"
        },
        "recipients": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Recipient addresses (To)"
        },
        "cc": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Carbon-copy addresses (CC)"
        },
        "subject": {
          "type": "string"
        },
        "related_entity_type": {
          "type": [
            "string",
            "null"
          ],
          "description": "Type of the SINGLE related entity (e.g. INVOICE for an invoice,\nUSER, SUBSCRIPTION). `null` for batch emails (BULK_INVOICES): their\nrelation is the invoices in `related_invoices`, not a single entity.\n"
        },
        "related_entity_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "Id of the single related entity. `null` for batch emails."
        },
        "status": {
          "$ref": "#/$defs/EmailDeliveryStatus"
        },
        "sent_at": {
          "type": "string",
          "format": "date-time",
          "description": "Time the email was sent"
        },
        "body_available": {
          "type": "boolean",
          "description": "`true` if the email content could be retrieved from the provider.\n`false` if the email has no provider id or the provider no longer\nretains it.\n"
        },
        "html_body": {
          "type": [
            "string",
            "null"
          ],
          "description": "HTML body of the email as it was sent. Null if not available."
        },
        "text_body": {
          "type": [
            "string",
            "null"
          ],
          "description": "Plain-text body of the email. Null if not available."
        },
        "attachments": {
          "type": "array",
          "description": "Email attachments (e.g. the invoice PDF). In invoice emails the actual\ncontent goes here, not in the body.\n",
          "items": {
            "$ref": "#/$defs/EmailAttachment"
          }
        },
        "related_invoices": {
          "type": "array",
          "description": "Invoices included in a batch email (BULK_INVOICES). Each element links\nto its invoice. Absent/empty in single-entity emails.\n",
          "items": {
            "$ref": "#/$defs/RelatedInvoice"
          }
        }
      }
    },
    "EmailDeliveryStatus": {
      "type": "string",
      "enum": [
        "QUEUED",
        "REJECTED",
        "SENT",
        "FAILED",
        "DELIVERED",
        "BOUNCED",
        "OPENED"
      ],
      "description": "Status of an email.\n\nThe history records every email the system decided to send, not only the ones that\nwent out: an email stopped by policy is listed as REJECTED rather than omitted.\n\n- QUEUED: authorised and recorded, not dispatched yet\n- REJECTED: stopped by policy and never sent (terminal, not retried). In test\n  environments invoices may only be emailed to the account owner's own address\n  (`+tag` aliases included), so a message addressed elsewhere lands here\n- SENT: successfully sent to the provider\n- FAILED: sending failed\n- DELIVERED / BOUNCED / OPENED: reported by the provider's webhooks\n"
    },
    "RelatedInvoice": {
      "type": "object",
      "description": "Reference to an invoice included in an email (e.g. each invoice in a batch).",
      "required": [
        "id",
        "invoice_number"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "invoice_number": {
          "type": "string"
        }
      }
    },
    "ResponseMeta": {
      "type": "object",
      "properties": {
        "timestamp": {
          "type": "string",
          "format": "date-time"
        },
        "request_id": {
          "type": "string"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/beel-es-email-delivery-detail-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.