Search Contacts
GET {{baseUrl}}/api/v1/contacts/search
This API searches for contacts in your help desk portal.
OAuth Scope
Desk.search.READDesk.contacts.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
from | string | From index, starts from 0 | |
limit | string | No. of entities to fetch | |
id | string | ID of the contact <br>exact match<br> | |
fullName | string | Full name of the contact <br>wildcard search<br> | |
firstName | string | First name of the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
lastName | string | Last name of the contact <br>wildcard search<br> | |
email | string | Email ID of the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
phone | string | Phone number of the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
mobile | string | Mobile number of the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
accountName | string | Name of the account associated with the Contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
_all | string | Search throughout the contact <br>wildcard search<br> | |
customField1 | string | Custom field in the Contact <br>wildcard search<br> e.g customField1=cf_mappedWithAccount:true <br>empty check<br> e.g customField1=cf_mappedWithAccount:${empty} <br>not empty check<br> | |
customField2 | string | Custom field in the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> e.g customField2=cf_mappedWithAccount:${notempty} | |
customField3 | string | Custom field in the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField4 | string | Custom field in the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField5 | string | Custom field in the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField6 | string | Custom field in the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField7 | string | Custom field in the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField8 | string | Custom field in the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField9 | string | Custom field in the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField10 | string | Custom field in the contact <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
createdTimeRange | string | Key that filters contacts created in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z | |
modifiedTimeRange | string | Key that filters contacts modified in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z | |
sortBy | string | SortBy can be: <br>relevance,<br> <br>modifiedTime,<br> <br>createdTime,<br> <br>lastName,<br> <br>firstName<br> |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"lastName":"Lawrence","modifiedTime":"2016-05-04T09:57:17.000Z","country":null,"secondaryEmail":null,"city":null,"description":null,"ownerId":"1892000000042001","type":null,"title":null,"photoURL":"https://desk.zoho.com/api/v1/contacts/1892000000042032/photo","twitter":null,"street":null,"createdTime":"2013-11-04T11:21:07.000Z","isEndUser":"false","zohoCRMContact":{"id":"5000000014010","type":"contacts_leads"},"customerHappiness":{"badPercentage":"22","okPercentage":"31","goodPercentage":"47"},"state":null,"id":"1892000000042032","email":"lawrence@zylker.com","zip":null,"owner":{"firstName":"Twin","lastName":"john","photoURL":null,"emailId":"lawrence@zylker.com","id":"1892000000042001","zuid":"14345345"},"cf":{"cf_permanentaddress":null,"cf_lastcontactedon":null},"facebook":null,"mobile":null,"accountId":"1892000000975382","firstName":"Jennifer","phone":"1 888 900 9646","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38","account":{"website":null,"accountName":"Zylker","id":"1892000000975382"}}],"count":1}