getFields Method - Comparison

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.0 Version 2.0
authtoken=**** Authorization=Zoho-oauthtoken ***** - as a Header.
scope=crmapi N/A
type N/A

Sample Responses:

+
Response in Version 1.0 Response 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.

    • Related Articles

    • getFields Method

      Table of Contents Purpose  Request URL  Request Parameters  Sample Response  Business Scenario  Purpose You can use the getFields method to fetch details of the fields available in a particular module. Request URL XML Format: ...

    • downloadPhoto Method - Comparison

      Purpose To download the photo of a lead or a contact. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/(Leads or Contacts)/downloadPhoto?authtoken=AuthToken&scope=crmapi&id=RecordID Version 2.0: URL: ...

    • downloadFile Method - Comparison

      Purpose To download a file attached to a record. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/Leads/downloadFile?authtoken=AuthToken&scope=crmapi&id=Attachment Id Version 2.0: URL: ...

    • deletePhoto Method - Comparison

      Purpose To delete a photo of a contact or lead. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/(Leads or Contacts)/deletePhoto?authtoken=AuthToken&scope=crmapi&id=RecordID Version 2.0: URL: https://www.zohoapis.com/crm/v2/{Leads or ...

    • deleteRecords Method - Comparison

      Purpose To delete the selected records. Request URL Version 1.0: https://crm.zoho.com/crm/private/xml/Leads/deleteRecords?authtoken=AuthToken&scope=crmapi&id=Record ID Version 2.0: URL: https://www.zohoapis.com/crm/v2/Leads/{record_id} Method: DELETE ...