Skip to main content
GET
Get Message

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

message_id
string
required

Response

Successful Response

Email message in API responses.

id
string
required
threadId
string
required
subject
string | null
required
bodyText
string | null
required
bodyHtml
string | null
required
snippet
string | null
required
status
enum<string>
required

Status of an email message through its lifecycle.

Available options:
DRAFT,
QUEUED,
SENDING,
SENT,
DELIVERED,
RECEIVED,
FAILED,
BOUNCED,
COMPLAINED
direction
enum<string>
required

Direction of an email message.

Available options:
INBOUND,
OUTBOUND
sentDate
string<date-time> | null
required
deliveredDate
string<date-time> | null
required
isRead
boolean
required
isStarred
boolean
required
isDraft
boolean
required
createdDate
string<date-time>
required
updatedDate
string<date-time> | null
required
messageType
enum<string>
default:CUSTOM

Type of email message.

Available options:
CUSTOM,
INVOICE,
TENANT_CREATED,
PROVIDER_INVITE,
PURCHASE_ORDER,
RECEIPT,
NOTIFICATION,
WEBHOOK_FAILED,
FORM,
BLAST,
OUTREACH
draftKind
enum<string> | null

How a draft was composed, so it resumes in the matching composer.

Only meaningful for DRAFT-status messages (NULL otherwise). REPLY/FORWARD drafts live inside an existing thread; a FORWARD draft must reopen in the forward composer (new thread, no in-reply-to) rather than as a reply.

Available options:
NEW,
REPLY,
FORWARD
participants
EmailParticipantResponse · object[]
attachments
EmailAttachmentResponse · object[]
openCount
integer
default:0
uniqueOpenCount
integer
default:0
clickCount
integer
default:0
uniqueClickCount
integer
default:0
firstOpenedDate
string<date-time> | null
lastOpenedDate
string<date-time> | null