List contacts

GET {{baseUrl}}/api/v1/contacts

This API lists a particular number of contacts, based on the limit specified.

OAuth Scope

Desk.contacts.READ

Request Params

Key	Datatype	Description
`include`	string	Secondary information related to the contact.Value supported is `accounts`.
`from`	string	Index number, starting from which the contacts must be fetched
`limit`	string	Number of contacts to fetch
`viewId`	string	ID of the view to apply while fetching the resources
`sortBy`	string	Sort by a specific attribute: `firstName`, `lastName`, 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

{&quot;data&quot;:[{&quot;lastName&quot;:&quot;Case&quot;,&quot;secondaryEmail&quot;:null,&quot;mobile&quot;:&quot;+91 8508569683&quot;,&quot;ownerId&quot;:null,&quot;type&quot;:null,&quot;accountId&quot;:&quot;1892000000091433&quot;,&quot;firstName&quot;:&quot;Jonathan&quot;,&quot;photoURL&quot;:&quot;https://desk.zoho.com/api/v1/contacts/1892000000772003/photo&quot;,&quot;isAnonymous&quot;:false,&quot;phone&quot;:&quot;1 888 900 9646&quot;,&quot;webUrl&quot;:&quot;https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38&quot;,&quot;createdTime&quot;:&quot;2015-02-16T14:46:24.000Z&quot;,&quot;isEndUser&quot;:false,&quot;zohoCRMContact&quot;:null,&quot;id&quot;:&quot;1892000000772003&quot;,&quot;isSpam&quot;:false,&quot;customerHappiness&quot;:{&quot;badPercentage&quot;:&quot;0&quot;,&quot;okPercentage&quot;:&quot;0&quot;,&quot;goodPercentage&quot;:&quot;0&quot;},&quot;email&quot;:&quot;case@zylker.com&quot;},{&quot;lastName&quot;:&quot;Jade&quot;,&quot;secondaryEmail&quot;:null,&quot;mobile&quot;:null,&quot;ownerId&quot;:null,&quot;type&quot;:null,&quot;accountId&quot;:&quot;1892000000052077&quot;,&quot;firstName&quot;:&quot;Christ&quot;,&quot;photoURL&quot;:null,&quot;isAnonymous&quot;:false,&quot;phone&quot;:null,&quot;webUrl&quot;:&quot;https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38&quot;,&quot;createdTime&quot;:&quot;2015-02-16T14:46:24.000Z&quot;,&quot;isEndUser&quot;:false,&quot;zohoCRMContact&quot;:{&quot;id&quot;:&quot;1892000000772030&quot;,&quot;type&quot;:&quot;contacts_leads&quot;},&quot;id&quot;:&quot;1892000000772001&quot;,&quot;isSpam&quot;:false,&quot;customerHappiness&quot;:{&quot;badPercentage&quot;:&quot;22&quot;,&quot;okPercentage&quot;:&quot;31&quot;,&quot;goodPercentage&quot;:&quot;47&quot;},&quot;email&quot;:&quot;jade@zylker.com&quot;}]}