GET - Get all contacts
Purpose
Use this API to get all contacts.
Authorization
HeaderKey | Description |
Authorization* | Zoho-oauthtoken<space><ACCESS_TOKEN> |
Accept* | Set to application/json. |
Request URL
Method: GET
https://voice.zoho.com/rest/json/zv/contacts |
Scope: zohovoice.contacts.READ
Parameters:
Param Name | Data Type | Description |
totalCount | Boolean | Represents whether the total count of contacts is required.
Possible values:
|
from | Integer | Represents the starting index. Default value is 0 |
size | Integer | Represents the number of records to be returned. Allowed range: 1-50 |
Sample Request
Copiedcurl "https://voice.zoho.com/rest/json/zv/contacts" \
-X GET \
-H "Authorization:Zoho-oauthtoken *****"Sample Response - Success
Copied{
"code": "200",
"meta": {
"total": -1
},
"contacts": [
{
"country": "",
"is_spam": "",
"address": "",
"mobile": "+15135493562",
"mobile1": "",
"phone2": "",
"last_name": "8Foller",
"phone3": "",
"is_favourite": "",
"contact_id": "347000014281004",
"phone1": "",
"phone": "+15135495601",
"mobile3": "",
"contact_owner": {
"display_value": "Vignesh",
"id": "347000000003015"
},
"mobile2": "",
"company": "",
"state": "",
"first_name": "Andrej",
"email": ""
},
{
"country": "",
"is_spam": "",
"address": "",
"mobile": "+18562644130",
"mobile1": "",
"phone2": "",
"last_name": "91Venere",
"phone3": "",
"is_favourite": "",
"contact_id": "347000014281005",
"phone1": "",
"phone": "+18566368749",
"mobile3": "",
"contact_owner": {
"display_value": "Vignesh",
"id": "347000000003015"
},
"mobile2": "",
"company": "",
"state": "",
"first_name": "Art",
"email": ""
}
],
"status": "SUCCESS"
}Sample Response - Error
Copied{
"code": "<App Error Code>",
"message": "<Error Message>",
"status": "ERROR"
}