List accounts
GET {{baseUrl}}/api/v1/accounts
This API lists a particular number of accounts, based on the limit specified.
OAuth Scope
Desk.contacts.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
from | string | Index number, starting from which the accounts must be listed | |
limit | string | Number of accounts to fetch | |
viewId | string | ID of the view to apply while fetching the resources | |
sortBy | string | Sort by a specific attribute: accountName or createdTime. The default sorting order is ascending. A - prefix denotes descending order of sorting. | |
fields | string | Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: photoURL, webUrl. Maximum of 30 fields is supported as comma separated values. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"website":"112121","accountName":"Admin Account","phone":"121212","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38","createdTime":"2015-02-16T16:57:44.000Z","zohoCRMAccount":{"id":"32754000000537001"},"customerHappiness":{"badPercentage":"30","okPercentage":"30","goodPercentage":"40"},"id":"1892000000052077","email":"admin@zylker.com"},{"website":"1211212","accountName":"Agent Account","phone":"11211","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38","createdTime":"2015-02-16T16:57:44.000Z","zohoCRMAccount":{"id":"32754000000537001"},"customerHappiness":{"badPercentage":"20","okPercentage":"40","goodPercentage":"40"},"id":"1892000000052090","email":"agent@zylker.com"}]}