# Email

## Retrieve an email

`email.retrieve(strid)  -> EmailRetrieveResponse`

**get** `/v1/emails/{id}`

Retrieves a single email by its ID. Email fields are redacted based on the caller-specific privacy resolution, and the response includes a read-only `accessLevel`.

**[Required scope](/using-the-api/scopes/):** `emails:read`

**[Rate limit category](/using-the-api/rate-limits/):** Read

### Parameters

- `id: str`

  Unique identifier of the email to retrieve.

### Returns

- `class EmailRetrieveResponse: …`

  - `id: str`

    Unique identifier for the entity.

  - `access_level: Literal["FULL", "METADATA"]`

    The caller's resolved access level for this email.

    - `"FULL"`

    - `"METADATA"`

  - `created_at: str`

    ISO 8601 timestamp of when the entity was created.

  - `fields: Dict[str, Fields]`

    Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.

    - `value: Optional[FieldsValue]`

      The field value, or null if unset.

      - `str`

      - `float`

      - `bool`

      - `List[str]`

      - `class FieldsValueAddress: …`

        - `city: Optional[str]`

          City name.

        - `country: Optional[str]`

          2-letter ISO 3166-1 alpha-2 country code.

        - `latitude: Optional[float]`

          Latitude coordinate.

        - `longitude: Optional[float]`

          Longitude coordinate.

        - `postal_code: Optional[str]`

          Postal or ZIP code.

        - `state: Optional[str]`

          State or province.

        - `street: Optional[str]`

          Street address line 1.

        - `street2: Optional[str]`

          Street address line 2.

      - `class FieldsValueFullName: …`

        - `first_name: Optional[str]`

          The contact's first name.

        - `last_name: Optional[str]`

          The contact's last name.

    - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 12 more]`

      The data type of the field.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

      - `"HTML"`

  - `http_link: Optional[str]`

    URL to view the entity in the Lightfield web app, or null.

  - `object_type: Literal["email"]`

    Always `email`.

    - `"email"`

  - `relationships: Dict[str, Relationships]`

    Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).

    - `cardinality: str`

      Whether the relationship is `has_one` or `has_many`.

    - `object_type: str`

      The type of the related object (e.g. `account`, `contact`).

    - `values: List[str]`

      IDs of the related entities.

  - `updated_at: Optional[str]`

    ISO 8601 timestamp of when the entity was last updated, or null.

  - `external_id: Optional[str]`

    External identifier for the entity, or null if unset.

### Example

```python
from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
email_retrieve_response = client.email.retrieve(
    "id",
)
print(email_retrieve_response.id)
```

#### Response

```json
{
  "id": "eml_cm0abc456def789",
  "accessLevel": "FULL",
  "createdAt": "2026-05-01T09:00:00.000Z",
  "fields": {
    "$subject": {
      "value": "Following up on our chat",
      "valueType": "TEXT"
    },
    "$sentAt": {
      "value": "2026-05-01T08:30:00.000Z",
      "valueType": "DATETIME"
    },
    "$from": {
      "value": [
        "sales@acme.com"
      ],
      "valueType": "EMAIL"
    },
    "$to": {
      "value": [
        "lead@example.com"
      ],
      "valueType": "EMAIL"
    },
    "$cc": {
      "value": [
        "string"
      ],
      "valueType": "EMAIL"
    },
    "$bcc": {
      "value": [
        "string"
      ],
      "valueType": "EMAIL"
    },
    "$privacySetting": {
      "value": "string",
      "valueType": "TEXT"
    },
    "$body": {
      "value": "<p>Hi there,</p><p>Following up on our chat earlier this week.</p>",
      "valueType": "HTML"
    }
  },
  "httpLink": null,
  "objectType": "email",
  "relationships": {
    "$account": {
      "cardinality": "has_many",
      "objectType": "account",
      "values": [
        "acc_cm4stu901uvw234"
      ]
    },
    "$contact": {
      "cardinality": "has_many",
      "objectType": "contact",
      "values": [
        "con_cm2ghi789jkl012"
      ]
    }
  },
  "updatedAt": "2026-05-01T10:00:00.000Z",
  "externalId": "externalId"
}
```

## List emails

`email.list(EmailListParams**kwargs)  -> EmailListResponse`

**get** `/v1/emails`

Returns a paginated list of emails. Use `offset` and `limit` to paginate through results. Each email is privacy-filtered per caller, includes a read-only `accessLevel`, and may redact the subject at metadata-only access. `fields.$body` is not included on list items; use GET `/v1/emails/{id}` for message body HTML. See <u>[List endpoints](/using-the-api/list-endpoints/)</u> for more information about pagination.

**[Required scope](/using-the-api/scopes/):** `emails:read`

**[Rate limit category](/using-the-api/rate-limits/):** Search

### Parameters

- `limit: Optional[int]`

  Maximum number of records to return. Defaults to 25, maximum 25.

- `offset: Optional[int]`

  Number of records to skip for pagination. Defaults to 0.

### Returns

- `class EmailListResponse: …`

  - `data: List[Data]`

    Array of email objects for the current page.

    - `id: str`

      Unique identifier for the entity.

    - `access_level: Literal["FULL", "METADATA"]`

      The caller's resolved access level for this email.

      - `"FULL"`

      - `"METADATA"`

    - `created_at: str`

      ISO 8601 timestamp of when the entity was created.

    - `fields: Dict[str, DataFields]`

      Field map for this email. Does not include `$body`; retrieve the email by ID for message HTML.

      - `value: Optional[DataFieldsValue]`

        The field value, or null if unset.

        - `str`

        - `float`

        - `bool`

        - `List[str]`

        - `class DataFieldsValueAddress: …`

          - `city: Optional[str]`

            City name.

          - `country: Optional[str]`

            2-letter ISO 3166-1 alpha-2 country code.

          - `latitude: Optional[float]`

            Latitude coordinate.

          - `longitude: Optional[float]`

            Longitude coordinate.

          - `postal_code: Optional[str]`

            Postal or ZIP code.

          - `state: Optional[str]`

            State or province.

          - `street: Optional[str]`

            Street address line 1.

          - `street2: Optional[str]`

            Street address line 2.

        - `class DataFieldsValueFullName: …`

          - `first_name: Optional[str]`

            The contact's first name.

          - `last_name: Optional[str]`

            The contact's last name.

      - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 12 more]`

        The data type of the field.

        - `"ADDRESS"`

        - `"CHECKBOX"`

        - `"CURRENCY"`

        - `"DATETIME"`

        - `"EMAIL"`

        - `"FULL_NAME"`

        - `"MARKDOWN"`

        - `"MULTI_SELECT"`

        - `"NUMBER"`

        - `"SINGLE_SELECT"`

        - `"SOCIAL_HANDLE"`

        - `"TELEPHONE"`

        - `"TEXT"`

        - `"URL"`

        - `"HTML"`

    - `http_link: Optional[str]`

      URL to view the entity in the Lightfield web app, or null.

    - `object_type: Literal["email"]`

      Always `email`.

      - `"email"`

    - `relationships: Dict[str, DataRelationships]`

      Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).

      - `cardinality: str`

        Whether the relationship is `has_one` or `has_many`.

      - `object_type: str`

        The type of the related object (e.g. `account`, `contact`).

      - `values: List[str]`

        IDs of the related entities.

    - `updated_at: Optional[str]`

      ISO 8601 timestamp of when the entity was last updated, or null.

    - `external_id: Optional[str]`

      External identifier for the entity, or null if unset.

  - `object: str`

    The object type, always `"list"`.

  - `total_count: int`

    Total number of entities matching the query.

### Example

```python
from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
email_list_response = client.email.list()
print(email_list_response.data)
```

#### Response

```json
{
  "data": [
    {
      "id": "eml_cm0abc456def789",
      "accessLevel": "FULL",
      "createdAt": "2026-05-01T09:00:00.000Z",
      "fields": {
        "$subject": {
          "value": "Following up on our chat",
          "valueType": "TEXT"
        },
        "$sentAt": {
          "value": "2026-05-01T08:30:00.000Z",
          "valueType": "DATETIME"
        },
        "$from": {
          "value": [
            "sales@acme.com"
          ],
          "valueType": "EMAIL"
        },
        "$to": {
          "value": [
            "lead@example.com"
          ],
          "valueType": "EMAIL"
        },
        "$cc": {
          "value": [
            "string"
          ],
          "valueType": "EMAIL"
        },
        "$bcc": {
          "value": [
            "string"
          ],
          "valueType": "EMAIL"
        },
        "$privacySetting": {
          "value": "string",
          "valueType": "TEXT"
        }
      },
      "httpLink": null,
      "objectType": "email",
      "relationships": {
        "$account": {
          "cardinality": "has_many",
          "objectType": "account",
          "values": [
            "acc_cm4stu901uvw234"
          ]
        },
        "$contact": {
          "cardinality": "has_many",
          "objectType": "contact",
          "values": [
            "con_cm2ghi789jkl012"
          ]
        }
      },
      "updatedAt": "2026-05-01T10:00:00.000Z",
      "externalId": "externalId"
    },
    {
      "id": "eml_cm1xyz123uvw456",
      "accessLevel": "METADATA",
      "createdAt": "2026-04-29T15:12:00.000Z",
      "fields": {
        "$subject": {
          "value": "string",
          "valueType": "TEXT"
        },
        "$sentAt": {
          "value": "2026-04-29T15:11:30.000Z",
          "valueType": "DATETIME"
        },
        "$from": {
          "value": [
            "ceo@acme.com"
          ],
          "valueType": "EMAIL"
        },
        "$to": {
          "value": [
            "member@lightfield.com"
          ],
          "valueType": "EMAIL"
        },
        "$cc": {
          "value": [
            "string"
          ],
          "valueType": "EMAIL"
        },
        "$bcc": {
          "value": [
            "string"
          ],
          "valueType": "EMAIL"
        },
        "$privacySetting": {
          "value": "string",
          "valueType": "TEXT"
        }
      },
      "httpLink": null,
      "objectType": "email",
      "relationships": {
        "$account": {
          "cardinality": "has_many",
          "objectType": "account",
          "values": [
            "acc_cm4stu901uvw234"
          ]
        }
      },
      "updatedAt": "2026-04-29T15:12:00.000Z",
      "externalId": "externalId"
    }
  ],
  "object": "list",
  "totalCount": 2
}
```

## Send an email

`email.send(EmailSendParams**kwargs)  -> EmailSendResponse`

**post** `/v1/emails/send`

Sends an email via the connected email account that owns the `from` address. Currently supports new sends only; replies and forwards are not yet supported.

Supports idempotency via the `Idempotency-Key` header.

**[Required scope](/using-the-api/scopes/):** `emails:create`

**[Rate limit category](/using-the-api/rate-limits/):** Write

### Parameters

- `from_: str`

  Bare email address (no display name). Must match a connected email account owned by the API key user. Compared case-insensitively. Used as the From header when sending.

- `message_body: MessageBody`

  Email message body (HTML or plain text).

  - `content: str`

    Email body content.

  - `content_type: Optional[Literal["HTML", "TEXT"]]`

    Defaults to `HTML`.

    - `"HTML"`

    - `"TEXT"`

- `subject: str`

  Email subject. Cannot be empty.

- `to: Sequence[str]`

  Recipient email addresses (bare, no display names). At least 1, at most 500.

- `attachments: Optional[Sequence[str]]`

  Optional list of file IDs (uploaded via the Files API) to attach to the email. Maximum 5 attachments per email, each ≤ 3MB.

- `bcc: Optional[Sequence[str]]`

  Bcc recipients (same shape as `to`).

- `cc: Optional[Sequence[str]]`

  Cc recipients (same shape as `to`).

### Returns

- `class EmailSendResponse: …`

  - `sent_at: str`

    ISO 8601 timestamp of when the send completed.

### Example

```python
from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
email_send_response = client.email.send(
    from_="sales@acme.com",
    message_body={
        "content": "<p>Hi there,</p><p>Following up on our chat earlier this week.</p>"
    },
    subject="Following up on our chat",
    to=["lead@example.com"],
)
print(email_send_response.sent_at)
```

#### Response

```json
{
  "sentAt": "sentAt"
}
```

## Create a draft email

`email.draft(EmailDraftParams**kwargs)  -> EmailDraftResponse`

**post** `/v1/emails/draft`

Creates a draft in the connected email account that owns the `from` address. Mirrors native email-client behavior: only `from` is required — `to`, `cc`, `bcc`, `subject`, `messageBody`, and `attachments` are all optional. At least one of those optional fields must be populated; sending only `from` returns a 400.

Supports idempotency via the `Idempotency-Key` header.

**[Required scope](/using-the-api/scopes/):** `emails:create`

**[Rate limit category](/using-the-api/rate-limits/):** Write

### Parameters

- `from_: str`

  Bare email address (no display name). Must match a connected email account owned by the API key user. Compared case-insensitively. Mailbox where the draft is created.

- `attachments: Optional[Sequence[str]]`

  Optional list of file IDs (uploaded via the Files API) to attach to the draft. Maximum 5 attachments per draft, each ≤ 3MB.

- `bcc: Optional[Sequence[str]]`

  Bcc recipients (same shape as `to`).

- `cc: Optional[Sequence[str]]`

  Cc recipients (same shape as `to`).

- `message_body: Optional[MessageBody]`

  Email message body (HTML or plain text).

  - `content: str`

    Email body content.

  - `content_type: Optional[Literal["HTML", "TEXT"]]`

    Defaults to `HTML`.

    - `"HTML"`

    - `"TEXT"`

- `subject: Optional[str]`

  Email subject.

- `to: Optional[Sequence[str]]`

  Recipient email addresses (bare, no display names). Up to 500.

### Returns

- `class EmailDraftResponse: …`

  - `drafted_at: str`

    ISO 8601 timestamp of when the draft was created.

### Example

```python
from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
email_draft_response = client.email.draft(
    from_="sales@acme.com",
)
print(email_draft_response.drafted_at)
```

#### Response

```json
{
  "draftedAt": "draftedAt"
}
```

## Domain Types

### Email Draft Response

- `class EmailDraftResponse: …`

  - `drafted_at: str`

    ISO 8601 timestamp of when the draft was created.

### Email List Response

- `class EmailListResponse: …`

  - `data: List[Data]`

    Array of email objects for the current page.

    - `id: str`

      Unique identifier for the entity.

    - `access_level: Literal["FULL", "METADATA"]`

      The caller's resolved access level for this email.

      - `"FULL"`

      - `"METADATA"`

    - `created_at: str`

      ISO 8601 timestamp of when the entity was created.

    - `fields: Dict[str, DataFields]`

      Field map for this email. Does not include `$body`; retrieve the email by ID for message HTML.

      - `value: Optional[DataFieldsValue]`

        The field value, or null if unset.

        - `str`

        - `float`

        - `bool`

        - `List[str]`

        - `class DataFieldsValueAddress: …`

          - `city: Optional[str]`

            City name.

          - `country: Optional[str]`

            2-letter ISO 3166-1 alpha-2 country code.

          - `latitude: Optional[float]`

            Latitude coordinate.

          - `longitude: Optional[float]`

            Longitude coordinate.

          - `postal_code: Optional[str]`

            Postal or ZIP code.

          - `state: Optional[str]`

            State or province.

          - `street: Optional[str]`

            Street address line 1.

          - `street2: Optional[str]`

            Street address line 2.

        - `class DataFieldsValueFullName: …`

          - `first_name: Optional[str]`

            The contact's first name.

          - `last_name: Optional[str]`

            The contact's last name.

      - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 12 more]`

        The data type of the field.

        - `"ADDRESS"`

        - `"CHECKBOX"`

        - `"CURRENCY"`

        - `"DATETIME"`

        - `"EMAIL"`

        - `"FULL_NAME"`

        - `"MARKDOWN"`

        - `"MULTI_SELECT"`

        - `"NUMBER"`

        - `"SINGLE_SELECT"`

        - `"SOCIAL_HANDLE"`

        - `"TELEPHONE"`

        - `"TEXT"`

        - `"URL"`

        - `"HTML"`

    - `http_link: Optional[str]`

      URL to view the entity in the Lightfield web app, or null.

    - `object_type: Literal["email"]`

      Always `email`.

      - `"email"`

    - `relationships: Dict[str, DataRelationships]`

      Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).

      - `cardinality: str`

        Whether the relationship is `has_one` or `has_many`.

      - `object_type: str`

        The type of the related object (e.g. `account`, `contact`).

      - `values: List[str]`

        IDs of the related entities.

    - `updated_at: Optional[str]`

      ISO 8601 timestamp of when the entity was last updated, or null.

    - `external_id: Optional[str]`

      External identifier for the entity, or null if unset.

  - `object: str`

    The object type, always `"list"`.

  - `total_count: int`

    Total number of entities matching the query.

### Email Retrieve Response

- `class EmailRetrieveResponse: …`

  - `id: str`

    Unique identifier for the entity.

  - `access_level: Literal["FULL", "METADATA"]`

    The caller's resolved access level for this email.

    - `"FULL"`

    - `"METADATA"`

  - `created_at: str`

    ISO 8601 timestamp of when the entity was created.

  - `fields: Dict[str, Fields]`

    Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.

    - `value: Optional[FieldsValue]`

      The field value, or null if unset.

      - `str`

      - `float`

      - `bool`

      - `List[str]`

      - `class FieldsValueAddress: …`

        - `city: Optional[str]`

          City name.

        - `country: Optional[str]`

          2-letter ISO 3166-1 alpha-2 country code.

        - `latitude: Optional[float]`

          Latitude coordinate.

        - `longitude: Optional[float]`

          Longitude coordinate.

        - `postal_code: Optional[str]`

          Postal or ZIP code.

        - `state: Optional[str]`

          State or province.

        - `street: Optional[str]`

          Street address line 1.

        - `street2: Optional[str]`

          Street address line 2.

      - `class FieldsValueFullName: …`

        - `first_name: Optional[str]`

          The contact's first name.

        - `last_name: Optional[str]`

          The contact's last name.

    - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 12 more]`

      The data type of the field.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

      - `"HTML"`

  - `http_link: Optional[str]`

    URL to view the entity in the Lightfield web app, or null.

  - `object_type: Literal["email"]`

    Always `email`.

    - `"email"`

  - `relationships: Dict[str, Relationships]`

    Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).

    - `cardinality: str`

      Whether the relationship is `has_one` or `has_many`.

    - `object_type: str`

      The type of the related object (e.g. `account`, `contact`).

    - `values: List[str]`

      IDs of the related entities.

  - `updated_at: Optional[str]`

    ISO 8601 timestamp of when the entity was last updated, or null.

  - `external_id: Optional[str]`

    External identifier for the entity, or null if unset.

### Email Send Response

- `class EmailSendResponse: …`

  - `sent_at: str`

    ISO 8601 timestamp of when the send completed.