Search accounts
GET {{baseUrl}}/api/v1/accounts/search
This API searches for accounts 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 account <br>exact match<br> | |
accountName | string | Name of the account <br>wildcard search<br> | |
_all | string | Search throughout the account <br>wildcard search<br> | |
customField1 | string | Custom field in the account <br>wildcard search<br> e.g customField1=cf_activeAccount:true <br>empty check<br> e.g customField1=cf_activeAccount:${empty} <br>not empty check<br> | |
customField2 | string | Custom field in the account <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> e.g customField2=cf_activeAccount:${notempty} | |
customField3 | string | Custom field in the account <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField4 | string | Custom field in the account <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField5 | string | Custom field in the account <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField6 | string | Custom field in the account <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField7 | string | Custom field in the account <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField8 | string | Custom field in the account <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField9 | string | Custom field in the account <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField10 | string | Custom field in the account <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
createdTimeRange | string | Key that filters accounts 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 accounts 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>accountName<br> |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"owner":{"firstName":"Twin","lastName":"john","photoURL":"https://desk.zoho.com/api/v1/agents/52338000000691001/photo?t=user\u0026ID=10657727","emailId":"jade@zylker.com","id":"3263000000057001","zuid":"10657727"},"country":"USA","modifiedTime":"2015-03-02T14:49:18.000Z","website":"www.zylker.com","code":"3211","cf":{"cf_contactcount":"1"},"accountName":"Zylker","city":null,"description":null,"industry":"Automation","ownerId":"3263000000057001","phone":"6218129190","street":null,"annualrevenue":null,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38","createdTime":"2015-02-16T16:57:44.000Z","state":null,"id":"3263000000074571","fax":"+1 444 8656 8732","email":"support@zylker.com"}],"count":1}