Kaizen #55 - Fields Metadata in Deals #API
Hello everyone!
Welcome back to another week of Kaizen!
This week, we will discuss the Fields Metadata API for the Deals module.
The Fields Metadata API gives you information about each field in a module.
We will discuss every key and its purpose in this post.
Request URL (to get all fields from a module): {api-domain}/crm/v2/settings/fields?{module_API_name}
Request URL (to get a specific field from a module): {api-domain}/crm/v2/settings/fields/{field_ID}?{module_API_name}
Request method: GET
Sample response for {api-domain}/crm/v2/settings/fields?Deals
Keys in the response
Key | Data type | Description |
system_mandatory | Boolean | Represents whether that field is system-mandatory during input. |
webhook | Boolean | Represents whether that field can be accessed through a webhook. |
json_type | String | Represents the JSON type of the field. |
crypt | JSON Object | Represents the mode and status of encryption of the field. "mode" can take the values "encryption", "decryption". "status" can take the values "1" (encrypted) and "2" ( encryption/decryption) is in progress. The value "null" represents the field is decrypted. |
field_label | String | Represents the label of the field in the UI in the user's preferred language. |
tooltip | JSON Object | Represents the name and the value of the tool tip, if you have provided one for the field. If there is no tooltip, this value is "null". |
created_source | String | Represents where the field was created from. The possible values are "default", "extension", or "integration". |
field_read_only | Boolean | Represents if the field is read-only or can be updated. |
display_label | String | Represents the display name of the field in the UI. This field will not be translated to the user's preferred language. |
read_only | Boolean | Represents if the field is read-only to the current user. |
quick_sequence_number | String | Represents the position of the field in the UI. |
businesscard_supported | Boolean | Represents if the current field can be added to the business card section on the Details view page of the record. |
currency | JSON Object | Represents the "rounding option" and the "precision" of the currency-type field. |
id | String | Represents the unique ID of the field. |
custom_field | Boolean | Represents if the field is a custom field. |
lookup | JSON Object | Represents that the field is a lookup and provides details such as the API name, module, ID, and display label of the module that this field is associated with. |
visible | Boolean | Represents if the field is visible to the current user. |
length | Integer | Represents the size of the field. |
view_type | JSON Object | Represents if the field is available on the View, Edit, Quick Create, and Create pages of the module. |
subform | JSON Object | Represents that the field is a part of a subform and gives details such as the subform module and its ID. |
api_name | String | Represents the API name of the field. |
unique | JSON Object | Represents that the field is marked unique and if it is case-sensitive. |
history_tracking | Boolean | Represents if the field is involved in tracking the history of the record. Applies for the picklist fields in the Leads module. |
data_type | String | Represents the CRM data type of the field as Owner lookup, currency, date etc. |
formula | JSON Object | Represents that the field is a formula field and gives details about the formula used. |
decimal_place | Integer | Represents the number of the decimal places allowed for the field. |
mass_update | Boolean | Represents if the field can be considered for a mass update. |
multiselectlookup | JSON Object | Represents that the field is a multi-select lookup field and gives details such as the display name, API name, linking module's name etc of the module that the field is associated with. |
pick_list_values | JSON Array | Represents the possible values of the picklist. |
auto_number | JSON Object | Represents the details of the auto number field such as the prefix, suffix, and the starting number. |
We hope you found this post useful. Write to us at support@zohocrm.com if you have any questions or let us know in the comments section.
Cheers!
Access your files securely from anywhere
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Shylaja S
Juan
Praveen Sankar
RW
Sticky Posts
Kaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideClient Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! CommandsExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achievedExtension pointers for integrating Zoho CRM with Zoho products #8: Upload and manage Zoho Workdrive folders and files from within Zoho CRM
Keeping records on your customers and business prospects is essential for tracking data, conducting follow-ups, and running a business smoothly. When you use two separate applications, and store relevant data in each, checking and tracking data becomes
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho Campaigns Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー