Get Multiple Contacts

  • URIs for Personal Contacts: /api/v1/accounts/self/contacts
    (or)
    /api/v1/accounts/{emailId}/contacts
  • URI for Org Contacts: /api/v1/accounts/org/contacts
  • Parameters Allowed: 

    • filter_categories=categoryId

      Note: You must get the categoryId by using the get all categories method.

    • include=(specific details by separated commas)
      Ex: include=emails,phones,ims
    • page=integer
    • per_page=integer
    • q=text (to search contacts)

Sync

Use page and per_page parameters to fetch any number of contacts.
If you'd like to have them fetched after a specified time, use filter_updated_time parameter.
If you'd like to see the deleted contacts as well, use include=show_deleted parameter. For sync, you must use filter_updated_time and include=show_deleted parameters in your query.

Example: https://contacts.zoho.com/api/v1/sync/self/contacts?page=1&per_page=100&filter_updated_time=1513936792108&include=show_deleted

 

Sample Request

Copiedhttps://contacts.zoho.com/api/v1/accounts/self/contacts?include=emails,phones,urls&page=1&per_page=4

Sample Response

Copied{
  "status_code": 200,
  "has_more": true,
  "resource_name": "contacts",
  "contacts": [
    {
      "created_time": 1532600990202,
      "updated_time": -1,
      "last_name": "last",
      "is_writable": true,
      "contact_id": "4685191000000029001",
      "middle_name": "ziddle",
      "emails": [
        {
          "email_id": "afirst1@gmail.com",
          "is_primary": true
        }
      ],
      "contact_type": "1",
      "zid": 11123456,
      "company": "cong",
      "contact_zuid": "-1",
      "photo_url": "https://contacts.zoho.com/images/user.gif",
      "first_name": "amber",
      "status": -10
    },
    {
      "created_time": 1532600991267,
      "updated_time": -1,
      "last_name": "second",
      "is_writable": true,
      "contact_id": "4685191000000029002",
      "emails": [
        {
          "email_id": "second1@gmail.com",
          "is_primary": true
        }
      ],
      "contact_type": "1",
      "zid": 11123456,
      "company": "cong",
      "contact_zuid": "-1",
      "photo_url": "https://contacts.zoho.com/images/user.gif",
      "first_name": "ankit",
      "status": -10
    },
    {
      "created_time": 1532600991294,
      "updated_time": 1532678700718,
      "last_name": "third",
      "phones": [
        {
          "number": "+4-545(4)7*,92.",
          "type": "mobile"
        }
      ],
      "is_writable": true,
      "contact_id": "4685191000000029003",
      "emails": [
        {
          "email_id": "third1@gmail.com",
          "is_primary": true
        }
      ],
      "contact_type": "1",
      "zid": 11123456,
      "company": "prog",
      "contact_zuid": "-1",
      "photo_url": "https://contacts.zoho.com/images/user.gif",
      "first_name": "aarui",
      "status": -10
    },
    {
      "created_time": 1532600991317,
      "updated_time": -1,
      "last_name": "fourth",
      "is_writable": true,
      "contact_id": "4685191000000029004",
      "emails": [
        {
          "email_id": "fourth1@gmail.com",
          "is_primary": true
        }
      ],
      "contact_type": "1",
      "zid": 11123456,
      "company": "prog",
      "contact_zuid": "-1",
      "photo_url": "https://contacts.zoho.com/images/user.gif",
      "first_name": "athira",
      "status": -10
    }
  ]
}