Get Started
Usage API
More information

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

Description

Returns a list of mail contacts with the contact information specified in the request.

Parameters
Name Description Type Example
infoType
sent in url
Information type Email, Phone Email
data
sent in url
Contact data string some text
isPrimary
sent in url
Contact importance: primary or not
optional
Bool value true
Example
GET api/2.0/mail/contacts/bycontactinfo?infoType=%22Email%22&data=%22some+text%22&isPrimary=true
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of filtered contacts

Example Response

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>