Get contacts by contact information

GET /api/2.0/mail/contacts/bycontactinfo

Request

Returns a list of mail contacts with the contact information 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

infoTypeinteger

Information type

datastring

Contact data

isPrimaryarray of boolean

Contact importance: primary or not

Examples

GET /api/2.0/mail/contacts/bycontactinfo HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/mail/contacts/bycontactinfo \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of filtered contacts

ContactIdintegerformat: int32
Namestring
Descriptionstring
Emailsarray of object
Idintegerformat: int32
Valuestring
IsPrimaryboolean
PhoneNumbersarray of object
Idintegerformat: int32
Valuestring
IsPrimaryboolean
Typeintegerformat: int32
SmallFotoUrlstring
MediumFotoUrlstring

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).