ZOzoho
contacts

List Contacts

List all contacts with pagination.

get/contacts

Request

  • Base URL
    https://www.zohoapis.com/invoice/v3
  • Auth
    OAuth 2
    Implicit: https://accounts.zoho.com/oauth/v2/auth
    Scopes: ZohoInvoice.contacts.READ

Query parameters

contact_namestring

Search contacts by contact name. <code>Maximum length [100]</code> Variants: <code>contact_name_startswith</code> and <code>contact_name_contains</code>. Maximum length [100]

company_namestring

Search contacts by company name. <code>Maximum length [100]</code> Variants: <code>company_name_startswith</code> and <code>company_name_contains</code>

first_namestring

Search contacts by first name of the contact person. <code>Maximum length [100]</code> Variants: <code>first_name_startswith</code> and <code>first_name_contains</code>

last_namestring

Search contacts by last name of the contact person. <code>Maximum length [100]</code> Variants: <code>last_name_startswith</code> and <code>last_name_contains</code>

addressstring

Search contacts by any of the address fields. <code>Maximum length [100]</code> Variants: <code>address_startswith</code> and <code>address_contains</code>

emailstring

Search contacts by email id of the contact person. <code>Maximum length [100]</code> Variants: <code>address_startswith</code> and <code>address_contains</code>

phonestring

Search contacts by phone number of the contact person. <code>Maximum length [100]</code> Variants: <code>phone_startswith</code> and <code>phone_contains</code>

filter_bystring

Filter contacts by status. Allowed Values: <code>Status.All, Status.Active, Status.Inactive, Status.Duplicate and Status.Crm</code>

search_textstring

Search contacts by contact name or notes. <code>Maximum length [100]</code>

sort_columnstring

Sort contacts. Allowed Values: <code>contact_name, first_name, last_name, email, outstanding_receivable_amount, created_time and last_modified_time</code>

zcrm_contact_idstring

CRM Contact ID for the contact.

zcrm_account_idstring

CRM Account ID for the contact.

pageinteger

Page number to be fetched. Default value is 1.

per_pageinteger

Number of records to be fetched per page. Default value is 200.

Response

OK

codeinteger
messagestring

Example response

{
  "message": "success",
  "contacts": [
    {
      "contact_name": "Bowman and Co",
      "company_name": "Bowman and Co",
      "contact_type": "customer",
      "status": "active",
      "payment_terms": 15,
      "payment_terms_label": "Net 15",
      "currency_code": "USD",
      "outstanding_receivable_amount": 250,
      "first_name": "Will",
      "last_name": "Smith",
      "email": "test@zylker.org",
      "phone": "1234",
      "mobile": "1234",
      "created_time": "2013-10-07T12:06:10+0530",
      "last_modified_time": "2013-11-08T18:24:51+0530"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.