Get contacts by search query

GET /api/2.0/mail/contacts

Request

Returns a list of filtered mail contacts by the search query 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

searchstring

Text to search in contact names or emails

contactTypearray of integer

Contact type

pageSizearray of integer

Number of contacts on the page

fromIndexinteger

Page number

sortorderstring

Sort order by name. String parameter: "ascending" or "descending"

Examples

GET /api/2.0/mail/contacts 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 \
  --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