Get Started
Usage API
More information

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

Description

Returns a list of filtered mail contacts by the search query specified in the request.

Parameters
Name Description Type Example
search
sent in url
Text to search in contact names or emails
optional
string some text
contactType
sent in url
Contact type
optional
number 1234
pageSize
sent in url
Count of contacts on page
optional
number 1234
fromIndex
sent in url
Page number
optional
number 1234
sortorder
sent in url
Sort order by name. String parameter: "ascending" - ascended, "descending" - descended string some text
Example
GET api/2.0/mail/contacts?search=some+text&fromIndex=1234&sortorder=some+text
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of filtered contacts