Returns a list of contacts from the CRM module with the contact information specified in the request.
Name | Description | Type | Example |
infoType
sent in url
|
Contact information type
optional
|
Phone, Email, Website, Skype, Twitter, LinkedIn, Facebook, Address, LiveJournal, MySpace, GMail, Blogger, Yahoo, MSN, ICQ, Jabber, AIM, VK | Phone |
data
sent in url
|
Contact data | string | some text |
category
sent in url
|
Contact category
optional
|
number | 1234 |
isPrimary
sent in url
|
Contact importance: primary or not
optional
|
Bool value | true |
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.
GET api/2.0/crm/contact/bycontactinfo?infoType=%22phone%22&data=%22some+text%22&category=1234&isPrimary=true Host: yourportal.onlyoffice.com Content-Type: application/json Accept: application/json
List of contacts
application/json
{ "status": 0, "response": [ { "Addresses": [ { "Street": "Lubanas st. 125a-25", "City": "", "State": "", "Zip": "LV-1021", "Country": "Latvia", "Category": 0, "CategoryName": "Home", "IsPrimary": true } ], "CreateBy": { "Id": "00000000-0000-0000-0000-000000000000", "DisplayName": "Mike Zanyatski", "Title": "Manager", "AvatarSmall": "url to small avatar", "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator" }, "Created": "2020-12-08T17:37:04.5916406Z", "About": "About", "Industry": "Industry", "ContactStatus": { "id": 1234, "Title": "Title", "Description": "Description", "Color": "#a7fc00", "SortOrder": 1 }, "ContactType": { "id": 1234, "Title": "Title", "Description": "Description", "Color": "#a7fc00", "SortOrder": 1 }, "CommonData": [ { "InfoType": 1, "Category": 0, "Data": "support@onlyoffice.com", "CategoryName": "Home", "IsPrimary": true, "id": 1234 } ], "CustomFields": [ { "EntityId": 14523423, "Label": "Birthdate", "FieldValue": "2020-12-08T17:37:04.5916406Z", "FieldType": 5, "Position": 10, "Mask": "", "id": 1234 } ], "Tags": [ "Tag1", "Tag2" ], "TaskCount": 1, "HaveLateTasks": true, "id": 1234, "SmallFotoUrl": "url to foto", "MediumFotoUrl": "url to foto", "DisplayName": "Tadjeddine Bachir", "IsCompany": false, "AccessList": [ { "Id": "00000000-0000-0000-0000-000000000000", "DisplayName": "Mike Zanyatski", "Title": "Manager", "AvatarSmall": "url to small avatar", "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator" } ], "IsPrivate": true, "IsShared": false, "ShareType": 0, "Currency": { "Title": "Chinese Yuan", "Symbol": "¥", "Abbreviation": "CNY", "CultureName": "CN", "IsConvertable": true, "IsBasic": false }, "CanEdit": true, "CanDelete": true } ] }
text/xml
<result> <status>0</status> <response> <Addresses> <Street>Lubanas st. 125a-25</Street> <City /> <State /> <Zip>LV-1021</Zip> <Country>Latvia</Country> <Category>0</Category> <CategoryName>Home</CategoryName> <IsPrimary>True</IsPrimary> </Addresses> <CreateBy> <Id>00000000-0000-0000-0000-000000000000</Id> <DisplayName>Mike Zanyatski</DisplayName> <Title>Manager</Title> <AvatarSmall>url to small avatar</AvatarSmall> <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl> </CreateBy> <Created>2020-12-08T17:37:04.5916406Z</Created> <About>About</About> <Industry>Industry</Industry> <ContactStatus> <id>1234</id> <Title>Title</Title> <Description>Description</Description> <Color>#a7fc00</Color> <SortOrder>1</SortOrder> </ContactStatus> <ContactType> <id>1234</id> <Title>Title</Title> <Description>Description</Description> <Color>#a7fc00</Color> <SortOrder>1</SortOrder> </ContactType> <CommonData> <InfoType>1</InfoType> <Category>0</Category> <Data>support@onlyoffice.com</Data> <CategoryName>Home</CategoryName> <IsPrimary>True</IsPrimary> <id>1234</id> </CommonData> <CustomFields> <EntityId>14523423</EntityId> <Label>Birthdate</Label> <FieldValue>2020-12-08T17:37:04.5916406Z</FieldValue> <FieldType>5</FieldType> <Position>10</Position> <Mask /> <id>1234</id> </CustomFields> <Tags>Tag1</Tags> <Tags>Tag2</Tags> <TaskCount>1</TaskCount> <HaveLateTasks>True</HaveLateTasks> <id>1234</id> <SmallFotoUrl>url to foto</SmallFotoUrl> <MediumFotoUrl>url to foto</MediumFotoUrl> <DisplayName>Tadjeddine Bachir</DisplayName> <IsCompany>False</IsCompany> <AccessList> <Id>00000000-0000-0000-0000-000000000000</Id> <DisplayName>Mike Zanyatski</DisplayName> <Title>Manager</Title> <AvatarSmall>url to small avatar</AvatarSmall> <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl> </AccessList> <IsPrivate>True</IsPrivate> <IsShared>False</IsShared> <ShareType>0</ShareType> <Currency> <Title>Chinese Yuan</Title> <Symbol>¥</Symbol> <Abbreviation>CNY</Abbreviation> <CultureName>CN</CultureName> <IsConvertable>True</IsConvertable> <IsBasic>False</IsBasic> </Currency> <CanEdit>True</CanEdit> <CanDelete>True</CanDelete> </response> </result>