getFields Method

getFields Method

Purpose

You can use the getFields method to fetch details of the fields available in a particular module.

Request URL

XML Format:
https://crm.zoho.com/crm/private/xml/Tasks/getFields?authtoken=Auth Token&scope=crmapi

JSON Format:
https://crm.zoho.com/crm/private/json/Tasks/getFields?authtoken=Auth Token&scope=crmapi

Note:

  • You can change the module name in the request URL to fetch fields from other modules.

Request Parameters

Parameter Data Type Description
authtoken* String Encrypted alphanumeric string to authenticate your Zoho credentials. 
scope* String Specify the value as crmapi.
type String

Specify the value as 1 or 2

  • 1 - To retrieve all fields from the summary view
  • 2 - To retrieve all mandatory fields from the module

Note: Do not specify the type, if you want to retrieve all fields from the module.

* - Mandatory parameter

Note:

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

Sample Response

<?xml version="1.0" encoding="UTF-8" ?>
- <Potentials>
  - <section name="Potential Information" dv="Potential Information">
    <FL req="false" type="Lookup" maxlength="120" label="Potential Owner" customfield="false" />
    <FL req="false" type="Currency" maxlength="16" fval="$0.00" label="Amount" customfield="false" />
    <FL req="true" type="Text" maxlength="120" label="Potential Name" customfield="false" />
    <FL req="true" type="Date" maxlength="20" label="Closing Date" customfield="false" />
    <FL req="true" type="Lookup" maxlength="100" label="Account Name" customfield="false" />
    + <FL req="true" type="Pick List" maxlength="100" label="Stage" customfield="false">
    + <FL req="false" type="Pick List" maxlength="120" label="Type" customfield="false">
    <FL req="false" type="Integer" maxlength="3" label="Probability" customfield="false" />
    <FL req="false" type="Text" maxlength="100" label="Next Step" customfield="false" />
    <FL req="false" type="Currency" maxlength="16" fval="$0.00" label="Expected Revenue" customfield="false" />
    + <FL req="false" type="Pick List" maxlength="120" label="Lead Source" customfield="false">
    <FL req="false" type="Lookup" maxlength="50" label="Campaign Source" customfield="false" />
    <FL req="false" type="Lookup" maxlength="50" label="Contact Name" customfield="false" />
    <FL req="false" type="OwnerLookup" maxlength="25" label="Created By" customfield="false" />
    <FL req="false" type="OwnerLookup" maxlength="25" label="Modified By" customfield="false" />
    <FL req="false" type="Text" maxlength="10" label="newfield" customfield="true" />
    </section>
   -<section name="Description Information" dv="Description Information">
    <FL req="false" type="TextArea" maxlength="32000" label="Description" customfield="false" />
</section>
</Potentials>

Additional Notes

  • While retrieving data from your Zoho CRM account Field-level security is applied. See Security Administration  for more details.

Business Scenario

  • Field mapping when integrating with 3rd party apps

    • Related Articles

    • getFields Method - Comparison

      Purpose To retrieve details of fields available in a module. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/Leads/getFields?authtoken=AuthToken&scope=crmapi Version 2.0: URL: ...

    • deleteRecords Method

      Table of Contents Purpose Request URL Request Parameters Example Purpose You can use this method to delete the selected record (you must specify unique ID of the record) and move to the recycle bin. Note: This method is availablefor all modules. ...

    • downloadPhoto Method

       Purpose You can use this method to download the photos of Leads or Contacts.  Request URL XML Format: For Leads: https://crm.zoho.com/crm/private/xml/Leads/downloadPhoto?authtoken=Auth Token&scope=crmapi&id=RecordID For Contacts: ...

    • searchRecords Method

       Purpose You can use the searchRecords method to get the list of records that meet your search criteria.  Request URL XML Format: https://crm.zoho.com/crm/private/xml/Leads/searchRecords?authtoken=Auth Token&scope=crmapi&criteria=(((Last ...

    • deleteFile Method

      Purpose You can use this method to delete files attached to records. Request URL XML Format: https://crm.zoho.com/crm/private/xml/Leads/deleteFile?authtoken=Auth Token&scope=crmapi&id=Attachment Id JSON Format: ...