Get Started
Usage API
More information

GET api/2.0/mail/conversations This function requires authentication

Description

Returns the conversations with the parameters specified in the request if there were changes since last check date.

Parameters
Name Description Type Example
folder
sent in url
Folder type: 1 - inbox, 2 - sent, 3 - drafts, 4 - trash, 5 - spam
optional
number 1234
unread
sent in url
Conversation status: unread (true), read (false) or all (null) messages
optional
Bool value true
attachments
sent in url
Defines if a conversation has attachments or not: with attachments (true), without attachments (false) or all (null) messages
optional
Bool value true
period_from
sent in url
Start search period date
optional
number 1234
period_to
sent in url
End search period date
optional
number 1234
important
sent in url
Important conversation or not
optional
Bool value true
from_address
sent in url
Mail address from which a letter came
optional
string some text
to_address
sent in url
Mail address to which a letter came
optional
string some text
mailbox_id
sent in url
Recipient mailbox ID
optional
number 1234
tags
sent in url
IDs of tags linked to the target conversation
optional
Collection of numbers
collection
1234
search
sent in url
Text to search in conversation body and subject
optional
string some text
page_size
sent in url
Count of conversations on page
optional
number 1234
sortorder
sent in url
Sort order by date: "ascending" - ascended, "descending" - descended string some text
from_date
sent in url
Date from which conversation search performed
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
from_message
sent in url
Message from which conversation search performed
optional
number 1234
with_calendar
sent in url
Conversation has a calendar or not
optional
Bool value true
user_folder_id
sent in url
User folder ID
optional
number 1234
prev_flag
sent in url
Sorting direction of conversation list (previous or next)
optional
Bool value true
Example
GET api/2.0/mail/conversations?from_address=some+text&to_address=some+text&tags=%5b1234%5d&search=some+text&sortorder=some+text&from_date=2008-04-10T06-30-00.000Z
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of filtered conversations