# Email

## Retrieve an email

`client.email.retrieve(stringid, RequestOptionsoptions?): 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: string`

  Unique identifier of the email to retrieve.

### Returns

- `EmailRetrieveResponse`

  - `id: string`

    Unique identifier for the entity.

  - `accessLevel: "FULL" | "METADATA"`

    The caller's resolved access level for this email.

    - `"FULL"`

    - `"METADATA"`

  - `createdAt: string`

    ISO 8601 timestamp of when the entity was created.

  - `fields: Record<string, 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: string | number | boolean | 3 more | null`

      The field value, or null if unset.

      - `string`

      - `number`

      - `boolean`

      - `Array<string>`

      - `Address`

        - `city?: string | null`

          City name.

        - `country?: string | null`

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

        - `latitude?: number | null`

          Latitude coordinate.

        - `longitude?: number | null`

          Longitude coordinate.

        - `postalCode?: string | null`

          Postal or ZIP code.

        - `state?: string | null`

          State or province.

        - `street?: string | null`

          Street address line 1.

        - `street2?: string | null`

          Street address line 2.

      - `FullName`

        - `firstName?: string | null`

          The contact's first name.

        - `lastName?: string | null`

          The contact's last name.

    - `valueType: "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"`

  - `httpLink: string | null`

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

  - `objectType: "email"`

    Always `email`.

    - `"email"`

  - `relationships: Record<string, Relationships>`

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

    - `cardinality: string`

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

    - `objectType: string`

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

    - `values: Array<string>`

      IDs of the related entities.

  - `updatedAt: string | null`

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

  - `externalId?: string | null`

    External identifier for the entity, or null if unset.

### Example

```typescript
import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const emailRetrieveResponse = await client.email.retrieve('id');

console.log(emailRetrieveResponse.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

`client.email.list(EmailListParamsquery?, RequestOptionsoptions?): 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

- `query: EmailListParams`

  - `limit?: number`

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

  - `offset?: number`

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

### Returns

- `EmailListResponse`

  - `data: Array<Data>`

    Array of email objects for the current page.

    - `id: string`

      Unique identifier for the entity.

    - `accessLevel: "FULL" | "METADATA"`

      The caller's resolved access level for this email.

      - `"FULL"`

      - `"METADATA"`

    - `createdAt: string`

      ISO 8601 timestamp of when the entity was created.

    - `fields: Record<string, Fields>`

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

      - `value: string | number | boolean | 3 more | null`

        The field value, or null if unset.

        - `string`

        - `number`

        - `boolean`

        - `Array<string>`

        - `Address`

          - `city?: string | null`

            City name.

          - `country?: string | null`

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

          - `latitude?: number | null`

            Latitude coordinate.

          - `longitude?: number | null`

            Longitude coordinate.

          - `postalCode?: string | null`

            Postal or ZIP code.

          - `state?: string | null`

            State or province.

          - `street?: string | null`

            Street address line 1.

          - `street2?: string | null`

            Street address line 2.

        - `FullName`

          - `firstName?: string | null`

            The contact's first name.

          - `lastName?: string | null`

            The contact's last name.

      - `valueType: "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"`

    - `httpLink: string | null`

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

    - `objectType: "email"`

      Always `email`.

      - `"email"`

    - `relationships: Record<string, Relationships>`

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

      - `cardinality: string`

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

      - `objectType: string`

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

      - `values: Array<string>`

        IDs of the related entities.

    - `updatedAt: string | null`

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

    - `externalId?: string | null`

      External identifier for the entity, or null if unset.

  - `object: string`

    The object type, always `"list"`.

  - `totalCount: number`

    Total number of entities matching the query.

### Example

```typescript
import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const emailListResponse = await client.email.list();

console.log(emailListResponse.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

`client.email.send(EmailSendParamsbody, RequestOptionsoptions?): 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

- `body: EmailSendParams`

  - `from: string`

    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.

  - `messageBody: MessageBody`

    Email message body (HTML or plain text).

    - `content: string`

      Email body content.

    - `contentType?: "HTML" | "TEXT"`

      Defaults to `HTML`.

      - `"HTML"`

      - `"TEXT"`

  - `subject: string`

    Email subject. Cannot be empty.

  - `to: Array<string>`

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

  - `attachments?: Array<string>`

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

  - `bcc?: Array<string>`

    Bcc recipients (same shape as `to`).

  - `cc?: Array<string>`

    Cc recipients (same shape as `to`).

### Returns

- `EmailSendResponse`

  - `sentAt: string`

    ISO 8601 timestamp of when the send completed.

### Example

```typescript
import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const emailSendResponse = await client.email.send({
  from: 'sales@acme.com',
  messageBody: { 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'],
});

console.log(emailSendResponse.sentAt);
```

#### Response

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

## Create a draft email

`client.email.draft(EmailDraftParamsbody, RequestOptionsoptions?): 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

- `body: EmailDraftParams`

  - `from: string`

    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?: Array<string>`

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

  - `bcc?: Array<string>`

    Bcc recipients (same shape as `to`).

  - `cc?: Array<string>`

    Cc recipients (same shape as `to`).

  - `messageBody?: MessageBody`

    Email message body (HTML or plain text).

    - `content: string`

      Email body content.

    - `contentType?: "HTML" | "TEXT"`

      Defaults to `HTML`.

      - `"HTML"`

      - `"TEXT"`

  - `subject?: string`

    Email subject.

  - `to?: Array<string>`

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

### Returns

- `EmailDraftResponse`

  - `draftedAt: string`

    ISO 8601 timestamp of when the draft was created.

### Example

```typescript
import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const emailDraftResponse = await client.email.draft({ from: 'sales@acme.com' });

console.log(emailDraftResponse.draftedAt);
```

#### Response

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

## Domain Types

### Email Draft Response

- `EmailDraftResponse`

  - `draftedAt: string`

    ISO 8601 timestamp of when the draft was created.

### Email List Response

- `EmailListResponse`

  - `data: Array<Data>`

    Array of email objects for the current page.

    - `id: string`

      Unique identifier for the entity.

    - `accessLevel: "FULL" | "METADATA"`

      The caller's resolved access level for this email.

      - `"FULL"`

      - `"METADATA"`

    - `createdAt: string`

      ISO 8601 timestamp of when the entity was created.

    - `fields: Record<string, Fields>`

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

      - `value: string | number | boolean | 3 more | null`

        The field value, or null if unset.

        - `string`

        - `number`

        - `boolean`

        - `Array<string>`

        - `Address`

          - `city?: string | null`

            City name.

          - `country?: string | null`

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

          - `latitude?: number | null`

            Latitude coordinate.

          - `longitude?: number | null`

            Longitude coordinate.

          - `postalCode?: string | null`

            Postal or ZIP code.

          - `state?: string | null`

            State or province.

          - `street?: string | null`

            Street address line 1.

          - `street2?: string | null`

            Street address line 2.

        - `FullName`

          - `firstName?: string | null`

            The contact's first name.

          - `lastName?: string | null`

            The contact's last name.

      - `valueType: "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"`

    - `httpLink: string | null`

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

    - `objectType: "email"`

      Always `email`.

      - `"email"`

    - `relationships: Record<string, Relationships>`

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

      - `cardinality: string`

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

      - `objectType: string`

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

      - `values: Array<string>`

        IDs of the related entities.

    - `updatedAt: string | null`

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

    - `externalId?: string | null`

      External identifier for the entity, or null if unset.

  - `object: string`

    The object type, always `"list"`.

  - `totalCount: number`

    Total number of entities matching the query.

### Email Retrieve Response

- `EmailRetrieveResponse`

  - `id: string`

    Unique identifier for the entity.

  - `accessLevel: "FULL" | "METADATA"`

    The caller's resolved access level for this email.

    - `"FULL"`

    - `"METADATA"`

  - `createdAt: string`

    ISO 8601 timestamp of when the entity was created.

  - `fields: Record<string, 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: string | number | boolean | 3 more | null`

      The field value, or null if unset.

      - `string`

      - `number`

      - `boolean`

      - `Array<string>`

      - `Address`

        - `city?: string | null`

          City name.

        - `country?: string | null`

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

        - `latitude?: number | null`

          Latitude coordinate.

        - `longitude?: number | null`

          Longitude coordinate.

        - `postalCode?: string | null`

          Postal or ZIP code.

        - `state?: string | null`

          State or province.

        - `street?: string | null`

          Street address line 1.

        - `street2?: string | null`

          Street address line 2.

      - `FullName`

        - `firstName?: string | null`

          The contact's first name.

        - `lastName?: string | null`

          The contact's last name.

    - `valueType: "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"`

  - `httpLink: string | null`

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

  - `objectType: "email"`

    Always `email`.

    - `"email"`

  - `relationships: Record<string, Relationships>`

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

    - `cardinality: string`

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

    - `objectType: string`

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

    - `values: Array<string>`

      IDs of the related entities.

  - `updatedAt: string | null`

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

  - `externalId?: string | null`

    External identifier for the entity, or null if unset.

### Email Send Response

- `EmailSendResponse`

  - `sentAt: string`

    ISO 8601 timestamp of when the send completed.