Get a conversation

GET /api/2.0/mail/conversation/{id:[0-9]+}

Request

Returns a list of messages linked in one chain (conversation).

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

idinteger

ID of any message from the conversation

loadAllarray of boolean

Loads the content of all messages

markReadarray of boolean

Specifies if a conversation will be marked as read or not

needSanitizearray of boolean

Specifies if HTML needs to be prepared for the FCK editor or not

Examples

GET /api/2.0/mail/conversation/%7Bid:[0-9]+%7D HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request GET \
  --url 'https://example.com/api/2.0/mail/conversation/%7Bid:[0-9]+%7D' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of messages linked in one chain

Attachmentsarray of object

fileIdintegerformat: int32

fileNamestring

sizeintegerformat: int64

contentTypestring

needSaveToTempboolean

contentIdstring

fileNumberintegerformat: int32

storedNamestring

streamIdstring

attachedAsLinkboolean

tempStoredUrlstring

Introductionstring

HtmlBodystring

ContentIsBlockedboolean

Importantboolean

Subjectstring

HasAttachmentsboolean

Bccstring

Ccstring

Tostring

Addressstring

Fromstring

ReplyTostring

Idintegerformat: int32

ChainIdstring

ChainDateStringstring

DateStringstring

DateDisplaystring

TagIdsarray of integer

LabelsInStringstring

IsNewboolean

IsAnsweredboolean

IsForwardedboolean

TextBodyOnlyboolean

Sizeintegerformat: int64

EMLLinkstring

StreamIdstring

RestoreFolderIdenum of integerformat: int32

[0 - Sending, 1 - Inbox, 2 - Sent, 3 - Draft, 4 - Trash, 5 - Spam, 6 - UserFolder, 7 - Templates]

Can be one of: Sending, Inbox, Sent, Draft, Trash, Spam, UserFolder, Templates.

Folderenum of integerformat: int32

[0 - Sending, 1 - Inbox, 2 - Sent, 3 - Draft, 4 - Trash, 5 - Spam, 6 - UserFolder, 7 - Templates]

Can be one of: Sending, Inbox, Sent, Draft, Trash, Spam, UserFolder, Templates.

UserFolderIdarray of integer

ChainLengthintegerformat: int32

WasNewboolean

IsTodayboolean

IsYesterdayboolean

ReceivedDatestring

IsBodyCorruptedboolean

HasParseErrorboolean

MimeMessageIdstring

MimeReplyToIdstring

CalendarUidstring

ReadRequestStatusboolean

401

Unauthorized