Fields Meta Data
Purpose
To get the field metadata for the specified module. The fields displayed are from all layouts for the module. The response does not contain layout-specific fields like mandatory fields or picklist values.
Request Details
Request URL
{api-domain}/crm/{version}/settings/fields?module={module_api_name}&type=unused
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, and Activities
Header
Authorization: Zoho-oauthtoken 100xx.92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.fields.READ
(or)
scope=ZohoCRM.settings.fields.ALL
(or)
scope=ZohoCRM.settings.ALL
Parameters
- modulestring, mandatory
Specify the API name of the required module. For example, Leads, Contacts, Accounts, Deals, and so on.
- typestring, optional
The value unused fetches all the unused fields and all fetches all both used and unused fields in the module. By default, the system fetches all the used fields.
- includestring, optional
The value allowed_permissions_to_update returns the JSON object "allowed_permissions" which gives the default permissions enabled for a field. Note that when you do not include this parameter in the request, the "allowed_permissions" JSON object is not included in the response.
Use the api_name of the fields in all API inputs instead of field labels. This ensures that the label name changes in custom modules or fields won't affect your existing integrations.
The fields whose permission is set as Don't Show will also be fetched in the response.
For all modules, ID is introduced as a field.
The data type of the Layout field is changed from bigint to layout, and the JSON type is changed from string to JSON Object.
The fields Enrich_Status__s, Last_Enriched_Time__s, Usage_Date__s, Usage_Count__s, Monthly_Limit__s, Add_On_Limit__s, Usage_Bulk_Count__s, Module__s and Feature_Name__s are introduced for the Data Enrichment Stats module. Note that these are the system-defined fields for this module.
In the Users module, the fields name_format__s and sort_order_preference__s are introduced
The name_format__s allows you to set your preference for the user's name such as "Salutation, First Name, Last Name" or "Salutation, Last Name, First Name".
The sort_order_preference__s allows you to sort the records in the response based on either the last name or first name. The default sorting happens by the record IDs.
Sample Request
Copiedcurl "https://www.zylkercorp.zohoplatform.com/crm/v4/settings/fields?module=Leads&include=allowed_permissions_to_update"
-X GET
-H "Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52"Response JSON Keys
- system_mandatoryboolean
Represents if current field is a system-mandatory field.
Possible values - true: The field is a system-mandatory field.
false: The field is not a system-mandatory field. - privateJSON object
Represents the details of compliance settings in your organization. For instance, "private": {
"restricted": true,
"type": "Low",
"export": true
}restricted(boolean)- Represents if normal/sensitive data have restricted access when accessed via API.
export(boolean)- Represents if both normal/sensitive data have restricted access when accessed via export.
type(string)- Represents the type of restriction. The possible values are Low/High based on field configuration in the layout.
- webhookboolean
Represents if the field is supported in webhook.
- virtual_fieldboolean
Represents if the field is virtual. Virtual fields are those that are used for reference purposes in subforms, multi-select lookups, multi-user lookups, ISONLINE, FULL_NAME etc. These fields contain meta properties but do not have actual values.
- json_typestring
Represents the JSON type of the field. For instance, JSON object, string, etc,.
- cryptJSON object
Represents the status of the encryption. For instance: "crypt": {
"mode": "encryption",
"status": 1
}
The possible values for the "mode" key are: encryption, decryption;
The possible values for the "status" key are:1 - Represents that the field is encrypted.
2- Represents that the encryption/decryption for the field is in progress.
- tooltipJSON object
Represents the details of the tooltip (name and value), if the field has one.
- created_sourcestring
Represents the source of the filed. The possible values for this field are: default, extension, and integration.
- display_labelstring
The display name of the field. This field will not be translated to user's preferred language. For instance, Lead Owner.
All display labels related to Events are renamed to Meetings. - field_labelstring
The display name of the field in the user's preferred language. All field labels related to Events are renamed to Meetings.
- field_read_onlyboolean
Represents if the field is read-only always.
Possible values - true: The field is always read-only.
false: The field is not always a read-only field, it can be updated. - allowed_permissions_to_updateJSON Object
Represents the default whether the user can read or edit the field, or if the field is hidden.
The value "true" for the keyread-only represents that the user can only view the field.
The value "true" for the key read-write represents that the user can edit the value of the field.
The value "true" for the key hidden represents that the field is hidden from the user. - read_onlyboolean
Represents if the field is read-only for the current user.
Possible values - true: The field read-only for the current user.
false: The field is not read-only for the current user. - display_labelboolean
Represents the display label of the current field. For instance, Last Name.
- quick_sequence_numberinteger
Represents the position of the field in the Vertical Solutions.
- businesscard_supportedboolean
Represents if the current field can be added to business card section.
Possible values - true: The field can be added to the business card section.
false: The field cannot be added to the business card section. - sharing_propertiesJSON object
In a lookup field, represents if the user has access to the records that the field looks up to.
- idstring
Represents the unique ID of the current field.
- custom_fieldboolean
Represents if the current field is a custom field.
Possible values - true: The field is a custom field.
false: The current field is a default field. - lookupJSON object
Represents the details of the lookup that the field is related to. For example, for the "Parent_Id" field in the inventory line item subform "Quoted_Items", the lookup key contains the API name and ID of the module that the field is related to.
In inventory line item subforms, for fields where the user selects a record from a list such as the Product name, the "lookup" key contains a JSON array "show_fields". This indicates the field that is displayed when a record is selected for that lookup. For example, for the "Product_Name" lookup, the users select a product. So, the show_fields key contains the fields that are displayed while you select the product. - visibleboolean
Represents if the current field is visible to the user.
Possible values - true: The field is visible to the user.
false: The current field is not visible to the user.
The profiles key represents the permission required for each profile to view this field. - profilesJSON array
Represents the different profiles that have access to this field and the access permission.
The value null represents that the user does not have the Module Customization permission. - display_typeinteger
Represents how the field is displayed based on its type .
The value -1 represents that the field is a normal field while the value 2 represents that the field is "select only" (Eg: Best time to contact field). - enable_colour_codeBoolean
Represents whether you can use color coding for that field.
- history_trackingJSON object
Represents the history of the picklist field if you have enabled history tracking.
The value null represents that history tracking is not enabled for the field. - wizardbigint
Represents that the field is a wizard.
- multiselectlookupJSON object
Represents the details such as linking module, connected module, lookup API name etc, of a multi-select lookup field.
- multiuserlookupJSON object
Represents the details such as linking module, connected module, lookup API name etc, of a multi-select user lookup field.
- pick_list_values_sorted_lexicallyBoolean
Represents whether the values of the picklist are sorted alphabetically.
- subformJSON object
Represents the details of the line items in the inventory modules.
- searchableBoolean
Represents whether the field is supported in a search.
- lengthinteger
Represents the size of the current field.
- sortableBoolean
Represents whether the field is sortable.
- api_namestring
Represents API name of the current field.
- data_typestring
Represents a field type of the current field. For instance, lookup.
- formulaJSON object
Represents the formula details, if the current field is a formula field.
- decimal_placeinteger
Represents the number of the decimal places allowed for the current field.
- mass_updateboolean
Represents if the field can be mass updated.
Possible values - true: The current field can be mass updated.
false: The current field cannot be mass updated. - enable_colour_codeboolean
Represents if the field can be color-coded.
- pick_list_valuesJSON array
Represents the list of all the picklist values, if the field is either a picklist or multi-select picklist field.
The value for the key type in each picklist option represents if that option is used or not.
The key id represents the unique ID of every picklist option.
colour_code represents the hex code for the color for that picklist value.
The response contains both used and unused picklist values. - auto_numberJSON object
Represents the auto-number details if the current field is an Auto-Number field.
Sample Response
Copied{
"fields": [
{
"webhook": true,
"field_label": "Record Id",
"tooltip": null,
"type": "used",
"field_read_only": true,
"display_label": "Record Id",
"allowed_permissions_to_update": {
"read_write": false,
"hidden": true,
"read_only": true
}
"read_only": true,
"association_details": null,
"businesscard_supported": false,
"multi_module_lookup": {},
"id": "3652397000003325001",
"created_time": null,
"filterable": true,
"visible": true,
"profiles": [
{
"permission_type": "read_only",
"name": "Administrator",
"id": "3652397000000026011"
},
{
"permission_type": "read_only",
"name": "Standard",
"id": "3652397000000026014"
},
{
"permission_type": "read_only",
"name": "Free",
"id": "3652397000001614008"
},
{
"permission_type": "read_only",
"name": "admin clone",
"id": "3652397000005787196"
},
{
"permission_type": "read_only",
"name": "Sales Manager",
"id": "3652397000009590009"
},
{
"permission_type": "read_only",
"name": "test23_$",
"id": "3652397000009593001"
}
],
"view_type": {
"view": true,
"edit": false,
"quick_create": false,
"create": false
},
"subform": null,
"separator": false,
"searchable": true,
"external": null,
"api_name": "id",
"unique": {},
"enable_colour_code": false,
"pick_list_values": [],
"system_mandatory": false,
"private": null,
"virtual_field": false,
"json_type": "string",
"crypt": null,
"created_source": "default",
"display_type": -1,
"ui_type": 52,
"modified_time": null,
"email_parser": {
"fields_update_supported": false,
"record_operations_supported": false
},
"currency": {},
"custom_field": false,
"lookup": {},
"convert_mapping": {
"Contacts": null,
"Deals": null,
"Accounts": null
},
"length": 18,
"display_field": false,
"pick_list_values_sorted_lexically": false,
"sortable": true,
"history_tracking": null,
"data_type": "bigint",
"formula": {},
"decimal_place": null,
"mass_update": false,
"multiselectlookup": {},
"auto_number": {}
},...
]
}