API Reference

Email

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve an email

client.Email.Get(ctx, id) (*EmailRetrieveResponse, error)

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: emails:read

Rate limit category: Read

ParametersExpand Collapse

id string

Unique identifier of the email to retrieve.

ReturnsExpand Collapse

type EmailRetrieveResponse struct{…}

ID string

Unique identifier for the entity.

AccessLevel EmailRetrieveResponseAccessLevel

The caller’s resolved access level for this email.

One of the following:

const EmailRetrieveResponseAccessLevelFull EmailRetrieveResponseAccessLevel = "FULL"

const EmailRetrieveResponseAccessLevelMetadata EmailRetrieveResponseAccessLevel = "METADATA"

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, EmailRetrieveResponseField]

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

Value EmailRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type EmailRetrieveResponseFieldValueArray []string

type EmailRetrieveResponseFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

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

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type EmailRetrieveResponseFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const EmailRetrieveResponseFieldValueTypeAddress EmailRetrieveResponseFieldValueType = "ADDRESS"

const EmailRetrieveResponseFieldValueTypeCheckbox EmailRetrieveResponseFieldValueType = "CHECKBOX"

const EmailRetrieveResponseFieldValueTypeCurrency EmailRetrieveResponseFieldValueType = "CURRENCY"

const EmailRetrieveResponseFieldValueTypeDatetime EmailRetrieveResponseFieldValueType = "DATETIME"

const EmailRetrieveResponseFieldValueTypeEmail EmailRetrieveResponseFieldValueType = "EMAIL"

const EmailRetrieveResponseFieldValueTypeFullName EmailRetrieveResponseFieldValueType = "FULL_NAME"

const EmailRetrieveResponseFieldValueTypeMarkdown EmailRetrieveResponseFieldValueType = "MARKDOWN"

const EmailRetrieveResponseFieldValueTypeMultiSelect EmailRetrieveResponseFieldValueType = "MULTI_SELECT"

const EmailRetrieveResponseFieldValueTypeNumber EmailRetrieveResponseFieldValueType = "NUMBER"

const EmailRetrieveResponseFieldValueTypeSingleSelect EmailRetrieveResponseFieldValueType = "SINGLE_SELECT"

const EmailRetrieveResponseFieldValueTypeSocialHandle EmailRetrieveResponseFieldValueType = "SOCIAL_HANDLE"

const EmailRetrieveResponseFieldValueTypeTelephone EmailRetrieveResponseFieldValueType = "TELEPHONE"

const EmailRetrieveResponseFieldValueTypeText EmailRetrieveResponseFieldValueType = "TEXT"

const EmailRetrieveResponseFieldValueTypeURL EmailRetrieveResponseFieldValueType = "URL"

const EmailRetrieveResponseFieldValueTypeHTML EmailRetrieveResponseFieldValueType = "HTML"

HTTPLink string

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

ObjectType EmailRetrieveResponseObjectType

Always email.

Relationships map[string, EmailRetrieveResponseRelationship]

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 []string

IDs of the related entities.

UpdatedAt string

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

ExternalID stringOptional

External identifier for the entity, or null if unset.

Retrieve an email

Go

HTTP

TypeScript

Python

Go

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  emailRetrieveResponse, err := client.Email.Get(context.TODO(), "id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", emailRetrieveResponse.ID)
}

200 example

{
  "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"
}

Returns Examples

200 example

{
  "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"
}