getFields

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: https://www.zohoapis.com/crm/v2/settings/fields?module={module_api_name}

Method: GET

Header: Authorization=Zoho-oauthtoken {oauth_token}

Request Parameters

Version 1.0Version 2.0
authtoken=****Authorization=Zoho-oauthtoken ***** - as a Header.
scope=crmapiN/A
typeN/A

Sample Responses:

+
Response in Version 1.0Response in Version 2.0
<?xml version="1.0" encoding="UTF-8" ?>
<Leads>
<section name="Lead Information" dv="Lead Information">
<FL req="false" type="Lookup" isreadonly="false" maxlength="120" label="Lead Owner" dv="Lead Owner" customfield="false"></FL>
..
..
</section>
</Leads>
{
  "fields": [
   {
    "custom_field": false,
    "lookup": {},
    "visible": true,
    "webhook": true,
    "json_type": "jsonobject",
    "crypt": null,
    "field_label": "Lead Owner",
    "length": 120,
    "tooltip": null,
    "view_type": {
     "view": true,
     "edit": true,
     "quick_create": false,
     "create": true,
    },
    "created_source": "default",
    "read_only": false,
    "api_name": "Owner",
    "unique": {},
    "businesscard_supported": true,
    "data_type": "ownerlookup",
    "formula": {},
    "currency": {},
    "id": "1386586000000002589",
    "decimal_place": null,
    "pick_list_values": [],
    "multiselectlookup": {},
    "auto_number": {}
   },
  ...
  ]
 }
 

Note:

In v2 API response, fields from all the layouts will be listed. To get specific layout fields then you need to call https://www.zohoapis.com/crm/v2/settings/layouts?module=Leads, GET API.

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocrm.com