List Associated contacts

GET {{baseUrl}}/v1/accounts/:accounts_id/contacts?from={from}&limit={limit}&sortBy={sortingField}

This API lists the contacts associated with an account

OAuth Scope

  • Desk.contacts.READ

Request Params

KeyDatatypeRequiredDescription
fromstringFrom index
limitstringNo. of contacts to fetch
sortBystringParameter that sorts contacts by one of these attributes: <br>firstName,<br> <br>lastName,<br> <br>fullName,<br> <br>phone,<br> <br>email,<br> <br>createdTime,<br> <br>modifiedTime<br>
isSpamstringFilters Spam contacts

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;lastName&quot;:&quot;Lawrence&quot;,&quot;secondaryEmail&quot;:null,&quot;mappingInfo&quot;:{&quot;mappingId&quot;:&quot;18026000003237019&quot;,&quot;mappingType&quot;:&quot;PRIMARY&quot;,&quot;isAccountTicketsViewable&quot;:true},&quot;mobile&quot;:&quot;+91 8508569683&quot;,&quot;type&quot;:null,&quot;ownerId&quot;:&quot;4000000008734&quot;,&quot;firstName&quot;:null,&quot;accountId&quot;:&quot;4000000008784&quot;,&quot;photoURL&quot;:null,&quot;isAnonymous&quot;:true,&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;2017-10-12T13:11:50.000Z&quot;,&quot;isEndUser&quot;:&quot;false&quot;,&quot;zohoCRMContact&quot;:{&quot;id&quot;:&quot;5000000014010&quot;,&quot;type&quot;:&quot;contacts_leads&quot;},&quot;customerHappiness&quot;:{&quot;badPercentage&quot;:&quot;0&quot;,&quot;okPercentage&quot;:&quot;0&quot;,&quot;goodPercentage&quot;:&quot;0&quot;},&quot;id&quot;:&quot;4000000008786&quot;,&quot;isSpam&quot;:false,&quot;email&quot;:&quot;support@zylker.com&quot;}]}