Get contacts by contact information

GET /api/2.0/crm/contact/bycontactinfo

Request

Returns a list of contacts from the CRM module with the contact information specified in the request.

Note: Please note that if the contact data from the "data" parameter refers to one of the contact information types, then the "infoType" parameter must be specified. For example, the "Paris" contact information is related to the "Address" information type.

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

infoTypearray of integer

Contact information type

datastring

Contact data

categoryarray of integer

Contact category

isPrimaryarray of boolean

Contact importance: primary or not

Examples

GET /api/2.0/crm/contact/bycontactinfo HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/crm/contact/bycontactinfo \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of contacts

Addressesarray of object

Streetstring

Citystring

Statestring

Zipstring

Countrystring

Categoryintegerformat: int32

CategoryNamestring

IsPrimaryboolean

CreateByobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

Createdstring

Aboutstring

Industrystring

ContactStatusobject

Titlestring

Descriptionstring

Colorstring

SortOrderintegerformat: int32

IDintegerformat: int32

ContactTypeobject

Titlestring

Descriptionstring

Colorstring

SortOrderintegerformat: int32

IDintegerformat: int32

CommonDataarray of object

InfoTypeenum of integerformat: int32

[0 - Phone, 1 - Email, 2 - Website, 3 - Skype, 4 - Twitter, 5 - LinkedIn, 6 - Facebook, 7 - Address, 8 - LiveJournal, 9 - MySpace, 10 - GMail, 11 - Blogger, 12 - Yahoo, 13 - MSN, 14 - ICQ, 15 - Jabber, 16 - AIM, 17 - VK]

Can be one of: Phone, Email, Website, Skype, Twitter, LinkedIn, Facebook, Address, LiveJournal, MySpace, GMail, Blogger, Yahoo, MSN, ICQ, Jabber, AIM, VK.

Categoryintegerformat: int32

Datastring

CategoryNamestring

IsPrimaryboolean

IDintegerformat: int32

CustomFieldsarray of object

EntityIdintegerformat: int32

Labelstring

FieldValuestring

FieldTypeenum of integerformat: int32

[0 - TextField, 1 - TextArea, 2 - SelectBox, 3 - CheckBox, 4 - Heading, 5 - Date]

Can be one of: TextField, TextArea, SelectBox, CheckBox, Heading, Date.

Positionintegerformat: int32

Maskstring

IDintegerformat: int32

Tagsarray of string

TaskCountintegerformat: int32

HaveLateTasksboolean

SmallFotoUrlstring

MediumFotoUrlstring

DisplayNamestring

IsCompanyboolean

AccessListarray of object

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

IsPrivateboolean

IsSharedboolean

ShareTypeenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read]

Can be one of: None, ReadWrite, Read.

Currencyobject

Titlestring

Symbolstring

Abbreviationstring

CultureNamestring

IsConvertableboolean

IsBasicboolean

CanEditboolean

CanDeleteboolean

IDintegerformat: int32

401

Unauthorized