Get filtered conversations

GET /api/2.0/mail/conversations

Request

Returns the conversations with the parameters specified in the request.

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

folderarray of integer

Folder type: 1 - inbox, 2 - sent, 3 - drafts, 4 - trash, 5 - spam

unreadarray of boolean

Conversation status: unread (true), read (false), or all (null) messages

attachmentsarray of boolean

Defines if a conversation has attachments or not: with attachments (true), without attachments (false), or all (null) messages

period_fromarray of integer

Start search period date

period_toarray of integer

End search period date

importantarray of boolean

Specifies if only important conversations will be displayed or not

from_addressstring

Mail address from which the conversation messages were received

to_addressstring

Mail address to which the conversation messages were sent

mailbox_idarray of integer

Recipient mailbox ID

tagsarray of integer

IDs of tags linked to the target conversation

searchstring

Text to search in the conversation bodies and subjects

page_sizearray of integer

Number of conversations on the page

sortorderstring

Sort order by date: "ascending" or "descending"

from_datestring

Start date of conversation search

from_messagearray of integer

Message from which the conversations are searched

with_calendararray of boolean

Specifies if the conversations have a calendar or not

user_folder_idarray of integer

User folder ID

prev_flagarray of boolean

Direction sort of the conversation list: true for previous, false for next

Examples

GET /api/2.0/mail/conversations HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/mail/conversations \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of filtered conversations

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