Developer API Help

getSearchRecordsByPDC Method


You can use this method to search the values based on predefined columns and custom lookup fields.

Request URL

XML Format: Token&scope=crmapi

JSON Format: Token&scope=crmapi

Request Parameters

Parameter Data Type Description
authotoken* String Encrypted alphanumeric string to authenticate your Zoho credentials.
scope* String Specify crmapi as the scope
selectColumns* String All or module(field 1,field 2,field 3, field n...)
Example: leads(Last Name,Website,Email)
searchColumn* String

Specify the predefined search column (Please refer to the Default Predefined Columns shown below).
Note: You can also search values based on custom lookup fields.

searchValue* String Specify the value to be searched
newFormat Integer newFormat=1: To exclude fields with "null" values while inserting data from your CRM account.
newFormat=2: To include fields with "null" values while inserting data from your CRM account.
version Integer version = 1: (Default value) This will fetch responses based on the earlier API implementation i.e prior to the enhancements made.
version = 2: This will fetch responses based on the latest API implementation.

* - Mandatory parameter


  • Refer the Release Notes page to learn more about enhancements made in the API implementation.

Default Predefined Columns

Module Fields
  • email
  • accountid
  • accountname
  • contactid
  • accountid
  • vendorid
  • email
  • potentialid
  • accountid
  • campaignid
  • contactid
  • potentialname
  • campaignid
  • campaignname
  • caseid
  • productid
  • accountid
  • potentialid
  • solutionid
  • productid
  • productid
  • vendorid
  • productname
Purchase Order
  • purchaseorderid
  • contactid
  • vendorid
  • quoteid
  • potentialid
  • accountid
  • contactid
Sales Orders
  • salesorderid
  • potentialid
  • accountid
  • contactid
  • quoteid
  • invoiceid
  • accountid
  • salesorderid
  • contactid
  • vendorid
  • vendorname
  • taskid
  • eventid
  • notesid

Examples Token&scope=crmapi &selectColumns=leads(Last Name,Website,Email)&searchColumn=email &

Leads with email column Token&scope=crmapi
&selectColumns=Leads(Last Name,Website,Email)

Leads with campaignid column Token&scope=crmapi
&selectColumns=Leads(Last Name,Website,Email)

Contacts with vendorid column Token&scope=crmapi
&selectColumns=Contacts(Contact Owner,Lead Source,First Name,Last Name,Account Name)

Products with vendorid column Token&scope=crmapi
&selectColumns=Products(Product Owner,Product Name,Product Code,Manufacturer,Product Category,Unit Price)

SalesOrders with accountid column Token&scope=crmapi
&selectColumns=SalesOrders(SO Number,Subject,Due Date,Carrier,Status)

Search records using custom lookup fields Token&scope=crmapi

This will return a response like below:

<row no="1">
<FL val="LEADID">108490000020024</FL>
<FL val="SMOWNERID">1081490000078001</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zylker Inc.</FL>
<FL val="Last Name">Scott</FL>
<FL val="SMCREATORID">1081490000078001</FL>
<FL val="Created By">John</FL>
<FL val="MODIFIEDBY">1081490000078001</FL>
<FL val="Modified By">John</FL>
<FL val="Created Time">2014-10-27 15:18:11</FL>
<FL val="Modified Time">2014-11-26 12:53:13</FL>
<FL val="Last Activity Time">2014-11-26 12:53:13</FL>
<FL val="ProductLookup_ID">108149000062016</FL>
<FL val="ProductLookup">CPU</FL>

Test Program

You can use the attached program to run and test the working of the getSearchRecordsByPDC method in your Java Environment.
The Java Program contains the following:

  • the authtoken generation format
  • the parameters and their values
  • actual usage of the method

Click here to download the program