Kaizen #50 - Deals Metadata #API
Hello everyone!
Welcome back to another post in the Kaizen series!
This week, we will discuss the Metadata API for the Deals module and explain every key in the response.
What are metadata?
Metadata are the additional information about a record's data or a module. For instance, the metadata of the Deals module comprises details like related list properties, whether the module is visible to the current user, whether the module can be accessed via API, and so on.
You can fetch the metadata of a module through the Module Metadata API.
Request URL: {api-domain}/crm/v2/settings/modules/module_API_name
Request method: GET
Sample response
Now, let us see the details of every key in the response.
Key | Data Type | Description |
global_search_supported | Boolean | Represents whether the records of the module are searchable globally (along with other modules). |
kanban_view | Boolean | Represents if the current view of the module's records is Kanban. |
deletable | Boolean | Represents if the current user can delete records from the module. |
description | String | Represents the description of the module. |
creatable | Boolean | Represents if the current user can create records in the module. |
filter_status | Boolean | Represents if the current custom view has additional filters applied. |
inventory_template_supported | Boolean | Represents if the module supports the usage of the inventory module templates. |
modified_time | DateTime (ISO 8601) | The date and time (in the current user's time zone) at which the module's properties were last modified. |
plural_label | String | The plural label of the module's name. |
presence_sub_menu | Boolean | Represents if there is a sub-menu for the module. |
triggers_supported | Boolean | Represents if the module supports triggers from custom buttons, workflows, approval etc. |
id | String | The unique ID of the module. |
isBlueprintSupported | Boolean | Represents if the module can participate in the blueprint process. |
related_list_properties | JSON Object | Represents the fields and the order they have to be displayed in, when this module is a related list in any other module. |
$properties | JSON Array | Represents the properties that the records of this module hold when they are involved in processes like approval, review etc. You receive the values of the fields in this array when you fetch a record from this module. Refer to our earlier post on $properties for details. |
per_page | Integer | Represents the number of records that are displayed per page in the UI. |
visibility | Integer | Represents the visibility of the module to the current user. 1 - The module is visible 0 - The module is hidden -1 - The module is unavailable/hidden by the system itself due to the downgrading of the plan. |
convertable | Boolean | Represents if the module's records can be converted into another module's records. For example, a lead can be converted to a contact, account or deal. |
editable | Boolean | Represents if the current user can edit the records in this module. |
emailTemplate_support | Boolean | Represents if the module supports the usage of the email templates. |
profiles | JSON Array | Represent the name and ID of the profiles that have the permission to access this module. |
filter_supported | Boolean | Represents if the module supports custom filters besides the system-defined ones in a custom view. |
display_field | String | Represents the data of the field that must be populated when a field of this module is a lookup field in another. |
search_layout_fields | JSON Array | Represents the fields you receive in the response when you search for the records of this module. |
kanban_view_supported | Boolean | Represents if this module's records can be viewed in the kanban view. |
show_as_tab | Boolean | Represents if you can view this module as a tab in the UI. |
web_link | URL | Represents the link you specified while creating a web tab. |
sequence_number | Integer | Represents the position of this module on the list of tabs in the UI. |
singular_label | String | Represents the singular label of the module's name. |
viewable | Boolean | Represents if the current user can view the records of this module. |
api_supported | Boolean | Represents if you can perform CRUD operations on the records of the module through the APIs. |
api_name | String | Represents the API name of the module. |
quick_create | Boolean | Represents if you can create records in this module from the Quick Create page. |
modified_by | JSON Object | The name and ID of the user who last modified the properties of the module. |
generated_type | String | Represents if the module was created by default, as custom or linking module, as a web tab, or a subform. |
feeds_required | Boolean | Represents if the module is given in feeds preference in the Feeds page in Zoho CRM. |
scoring_supported | Boolean | Represents if the records of the module qualify for the scoring process, if there is one. |
webform_supported | Boolean | Represents if the records in the module can be created via web forms. |
arguments | JSON Array | Represents the arguments you pass while opening a web tab. |
module_name | String | The name of the module. |
business_card_field_limit | Integer | Represents the number of fields you can have in the business card details. Note: Business card details are displayed on the "Details View" page of a record. This is also the information shown when you hover over a lookup field. |
custom_view | JSON Object | Represents the details of the current custom view of the current user. |
parent_module | String | Represents the API name of the parent module of this module. For example, the parent module for Calls, Tasks, and Meetings is Activities. |
We hope you found this post useful. Please write to us at support@zohocrm.com if you have any questions, or let us know in the comment section.
Cheers!
Access your files securely from anywhere
New to Zoho Recruit?
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
Sticky Posts
Kaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Kaizen #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Celebrating 200 posts of Kaizen! Share your ideas for the milestone post
Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQsKaizen #193: Creating different fields in Zoho CRM through API
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Client 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! Commands
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator 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セミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Project Change Orders and Additions
We are in the process of migrating from QuickBooks Online to Zoho Books. We have Zoho One and like the ability to sync all of our data across everything. And I like that projects work in a way that's less dumb than QuickBooks. I'm trying to figure outTrack online, in-office, and client location meetings separately with the new meeting venue option
Hello everyone! We’re excited to announce meeting enhancements in Zoho CRM that bring more clarity and structure to how meetings are categorized. You can now specify the meeting venue to clearly indicate whether a meeting is being held online, at theCreate custom rollup summary fields in Zoho CRM
Hello everyone, In Zoho CRM, rollup summary fields have been essential tools for summarizing data across related records and enabling users to gain quick insights without having to jump across modules. Previously, only predefined summary functions werePossible to send Zoom AI Companion transcripts and summaries to contacts in CRM?
Title says it all. Is it possible to send Zoom AI Companion transcripts and summaries to contacts in Zoho CRM?Introducing segments for targeted user engagement
Hello everyone, We’re excited to announce Segments in Zoho Apptics, a new way to group users based on their behavior, preferences, and app activity. With Segments, you can deliver more meaningful, timely, and relevant experiences to your users. When combinedHow do I edit the Calendar Invite notifications for Interviews in Recruit?
I'm setting up the Zoho Recruit Interview Calendar system but there's some notifications I don't have any control over. I've turned off all Workflows and Automations related to the Calendar Scheduling and it seems that it's the notification that is sentPosibility to add Emoticons on the Email Subject of Templates
Hi I´ve tried to add Emoticons on the Subject line of Email templates, the emoticon image does show up before saving the template or if I add the Emoticon while sending an Individual email and placing it manually on the subject line. Emoticons also showClarity on extended contract status
Clarity on “extended” status- How does Zoho “extend” a contract? E.g. if client extends by 1 month, can the “end date” be adjusted accordingly in Zoho and tagged as “Extended” with a clear audit trail that also captures the client’s email? Note- EmailCustomizing contract status
Can we customize/add/remove status on Zoho contracts ourselves or does Zoho needs to do this? Context- There is a long list of status on Zoho but not all of them are relevant for us . There are few status which are missing and needs to be added. E.g-Set Custom Business Calendars and Holidays for Global Teams
Managing a project across diverse teams means accounting for more than just tasks and deadlines; it means acknowledging how and when each team actually works. Users might follow different working days or observe region-specific holidays that cannot be[Integration edition] Deluge learning series - Integrations between Zoho apps and Third-party services with Deluge | 28 August 2025
We’re excited to welcome you to the Deluge learning series: Integration edition! The Integration edition will run for three months: Session 1 – Integrating Zoho Apps with Deluge using inbuilt integration tasks Session 2 – Integrating Zoho Apps with DelugeCritical Vulnerability in all major password manager plugins - is Zoho Vault affected?
Hi Zoho, a security researcher found a critical clickjacking vulnerability in all major browser password managers: DOM-based Extension Clickjacking: Your Password Manager Data at Risk | Marek Tóth Is Zoho Vault affected as well? Apparently the Vault extensionIntroducing SecureForms in Zoho Vault
Hey everyone, Let’s face it—asking someone to send over a password or other sensitive data is rarely straightforward. You wait. You nudge. You follow up once, twice—maybe more. And when the information finally arrives, it shows up in the worst possibleTables from ZohoSheets remove images when updated from source
I have a few tables from a ZohoSheet in a ZohoWriter document that will remove the images in the cells when I refresh from the source. The source still has the images in the table when I go to refresh. After updating from the source, as you can see theChange eMail Template for Event-Invitations
Hello ZOHO-CRM Team How I can change the eMail Template for Event-Invitations? I work with the German Version of the Free Version. I know how I can modify eMail alerts or Signature Templates, but where I can other eMails modify you send out? Thank you for your answer. Regards, JuergInventory Adjustments
Hi, How to transfer the material from one head to another ? Like materials purchased for manufacturing the laptop need to transfer from consumption inventory (Quantity of raw materials reduced) to destination inventory ( Quantity of Laptop increased)Need Your Insights
Hi Zoho, I'm confused why the flow only sends to one output. setVariable15 is from a list. It doesn't consider the 2nd entry. Any thoughts?Map Dependency Fields - How can can I limit picklist values from a multi-select Parent field?
I know the "Map Dependency Fields" feature doesn't allow a multi-select parent field. However, I need the functionality. Can I do it through a deluge function, and would it still support color coding picklists? We need the color coding for quick scanningDYK 1 - Color Palette for Enhanced Visual Identification of Status
Introducing the Did You Know series of posts. The goal of this series is to familiarize users with certain features or enhancements in Zoho Projects that may not be evident at first glance. The first post in this series deals with color palettes for indicatingInvalid field in the COQL query
Dear Zoho Support! I believe that you already helped me with a similar problem a few years ago. One of my clients has a custom field named "LOB" in the "Deals" Module (see the field's metadata below). The COQL query using this field: : "select id, Deal_Name,Automating Employee Birthday Notifications in Zoho Cliq
Have you ever missed a birthday and felt like the office Grinch? Fear not, the Cliq Developer Platform has got your back! With Zoho Cliq's Schedulers, you can be the office party-cipant who never forgets a single cake, balloon, or awkward rendition ofTransferring domain registration to new registrar and switching email hosting at the same time?
I need to transfer an existing domain uv cure adhesive that's currently with SiteGround to Porkbun. I also need to move the existing custom email addresses from SiteGround to Zoho Mail. I'm not sure if I should transfer the domain first and then tackleSplit deposits
Can Zoho do split deposits. One deposit, two checks for two separate invoices from different customers. This is one of the most common tasks I can imaging. When I mark the two invoices paid, there are two deposits in bank register. When I try to match,Feedback: Streamlining Note Management in Zoho Notebook
Dear Team/Support, I would like to share some feedback regarding the note management system that could help improve usability and accessibility for users like myself. Notebook 1 (screenshot attached): Currently, the system does not allow selecting andDeactivate Desk Contact without Deleting Contat
We have a client who has multiple tenants for regulatory purposes, and as such, has a few users that have email addresses in both tenants. They've then emailed into the ticketing system, so we have multiple contacts (no big deal, we want to keep theirDelete my store of Zoho commerce
Hi Team, I want to delete my stores of commerce. Please help me asap. Looking for the positive response soon. Thanks Shubham Chauhan Mob: +91-9761872650Ability to add VAT to Retainer Invoices
Hello, I've had a telephone conversation a month ago with Dinesh on this topic and my request to allow for the addition of VAT on Retainer Invoices. It's currently not possible to add VAT to Retainer Invoices and it was mutually agreed that there is absolutely no reason why there shouldn't be, especially as TAX LAW makes VAT mandatory on each invoice in Europe! So basically, what i'm saying is that if you don't allow us to add VAT to Retainer Invoices, than the whole Retainer Invoices becomes[Free Webinar] Learning Table Series - Zoho Creator for Asset Management with AI Enhancements
Hello Everyone! We’re excited to invite you to another edition of Learning Table Series, where we showcase how Zoho Creator empowers industries with innovative and automated solutions. Each month highlights a specific sector, and this time our focus isHow to set different item selling prices for Zoho Commerce and Zoho Books
Item selling prices for Zoho Commerce and Zoho Books are in sync. If we update the Item selling price in Books, the same will happen in commerce and vice versa. I need a separate commerce selling price for online users and a separate books selling priceMenu Building is completely broken
I have been 3 hours, I have not been able to edit the menu. Either it is completely broken, very little intuitive or I do now know anything... There is no way to create a megamenu, no way to create a menu. Despite the fact I go to menu configurartionCan you sell Subscriptions using Zoho Commerce?
In addition to physical products and the apparently coming soon 'Digital Products', it is possible to sell Subscriptions using Zoho Commerce?Kaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Multiple Languages for Product Names
Hi, I use 2 languages: spanish and english. I want to have for every product a name in spanish and a name on english. I want to have to possibility of choosing one of these languages when making an invoice or a purchase order. Is there any way to doItem with name in different languate
Hello, is there a way to have an item with its name in different languages? For example: I sell an item in different markets and I'd like to have a Proposal and the Invoice with the Item Name in a specific language. Rino Bertolotto Zoho Specialist, STESA srlContacts with most tickets? Alarm for multiple tickets?
Is it possible to see through the analytics/reports which contacts are creating the most tickets (not the most discussed ones)? Also, is there a way to set up a notification if a contact creates multiple tickets within a certain time frame?Issue with Template Subject Line Format in Zoho CRM
Hi Team, I’ve noticed that when I update the subject line of an email template in Zoho CRM, it sometimes appears in an incorrect format when used. Please see the attached screenshot for reference. Kindly look into this issue and fix this issue from backendTwo Data Labels in Bar Chart
I need to create a bar chart that has both the SUM and COUNT. I've concatenated them into a formula but it converts it into a stacked bar / scattered chart. The bar chart is no longer accessible. Since i'm comparing YOY, it would be best to have it inDisable field on subform row
Hi, Is it currently possible to disable a row item on a subform? I was just trying to do something whereby until another value is entered the field is disable but for the deluge scripting interface threw up an error saying such a function is not supported on a subform. Thanks in advance for your help. ShaheedLeads - Kanban view fit to screen
Hey guys, I created a custom layout for my leads, staged by lead status. I have 10 types of status. In Kanban view I see only 4 columns/stages and need to scroll to the right to see the rest. Is there a way to make columns/stages be displayed all together?Request to Differentiate Auto-Closed WhatsApp Conversations in SalesIQ
Hi Zoho Support, I’d like to raise a request related to the way WhatsApp conversations are auto-closed in SalesIQ. Every Monday, our Sales team has to manually review each closed WhatsApp conversation from the weekend to identify which ones were automaticallyNext Page