v19

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-017489931.2 KB

List 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</u> for more information about pagination.

Required scope: emails:read

Rate limit category: Search

get/v1/emails

Query parameters

offsetinteger

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

limitinteger

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

Headers

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

Response

OK

objectstring required

The object type, always "list".

totalCountinteger required

Total number of entities matching the query.

Example response

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