Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Email

Retrieve email details

Retrieves the details of a specific email by its ID.

get/emails/{id}

Path parameters

idstring required

The ID of the email.

Response

The email details.

idstring uuid required

The unique identifier of the email.

customer_idstring uuid required

The unique identifier of the customer. Returned from the GET /customers response.

status'' | 'initiated' | 'processed' | 'delivered' | 'open' | 'click' | 'bounce' | 'dropped' | 'deferred' | 'unsubscribe' | 'spamreport' required

Email status.

subjectstring required

The subject of the email.

contentstring required

The content of the email.

tm_createstring date-time required

Timestamp when the email was created.

tm_updatestring date-time required

Timestamp when the email was last updated.

tm_deletestring date-time required

Timestamp when the email was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "source": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destinations": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number"
    }
  ],
  "status": "delivered",
  "subject": "Your Call Recording is Ready",
  "content": "Please find your call recording attached.",
  "attachments": [
    {
      "reference_type": "recording",
      "reference_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123"
    }
  ],
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}