Returns a list of filtered mail contacts by the search query specified in the request.
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
|
Number of contacts on the page
optional
|
number | 1234 |
fromIndex
sent in url
|
Page number
optional
|
number | 1234 |
sortorder
sent in url
|
Sort order by name. String parameter: "ascending" or "descending" | string | some text |
GET api/2.0/mail/contacts?search=%22some+text%22&contactType=1234&pageSize=1234&fromIndex=1234&sortorder=%22some+text%22 Host: yourportal.onlyoffice.com Content-Type: application/json Accept: application/json
List of filtered contacts
application/json
{ "status": 0, "response": [ { "id": 1234, "name": "name", "description": "description", "emails": [ { "id": 1234, "value": "value", "isPrimary": true } ], "phones": [ { "id": 1234, "value": "value", "isPrimary": true } ], "type": 1234, "smallFotoUrl": "smallFotoUrl", "mediumFotoUrl": "mediumFotoUrl" } ] }
text/xml
<result> <status>0</status> <response> <id>1234</id> <name>name</name> <description>description</description> <emails> <id>1234</id> <value>value</value> <isPrimary>True</isPrimary> </emails> <phones> <id>1234</id> <value>value</value> <isPrimary>True</isPrimary> </phones> <type>1234</type> <smallFotoUrl>smallFotoUrl</smallFotoUrl> <mediumFotoUrl>mediumFotoUrl</mediumFotoUrl> </response> </result>