Meta Data APIs
Overview
The metadata APIs in Bigin allow you to fetch the metadata information related to various components within the Bigin. You can fetch metadata of the available modules, fields in a module, layouts associated with a module, custom views defined for a module and related lists configured for a module. The metadata of various components provides insights into the structure, configuration, and customization options available in Bigin. This information is useful for data mapping, customizations, and integrations.
Get modules metadata
Retrieve the metadata of a specific module.
Request URL
{api-domain}/bigin/v2/settings/modules/{module_api_name}
Choose domain-specific URL to replace {api-domain}
You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:
- For US, https://www.zohoapis.com
- For EU, https://www.zohoapis.eu
- For AU, https://www.zohoapis.com.au
- For IN, https://www.zohoapis.in
- For CN, https://www.zohoapis.com.cn
- For JP, https://www.zohoapis.jp
For more information, see Multi DC Support.
Authorization
For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.
Authorization: Zoho-oauthtoken <ACCESS_TOKEN>
You must authenticate using an access token that is associated with one of the following scopes:
- ZohoBigin.settings.modules.READ
- ZohoBigin.settings.modules.ALL
- ZohoBigin.settings.ALL
Request parameters
The available request parameters are given below:
Path parameters
module_api_name stringRequired
The API name of the module. The possible modules for this endpoint and their API name are given below:
| Module | API Name |
|---|---|
| Contacts | Contacts |
| Pipelines | Pipelines |
| Companies | Accounts |
| Products | Products |
| Tasks | Tasks |
| Events | Events |
| Calls | Calls |
| Associate Products | Associate_Products |
| Notes | Notes |
| Attachments | Attachments |
Sample request
Copiedcurl "https://www.zohoapis.com/bigin/v2/settings/modules/Pipelines" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/bigin/v2/settings/modules/Pipelines"
type: GET
connection:"connection_link_name"
];
info response;Response object
The response object contains the following details:
global_search_supported boolean
Has the value true if the module supports global search or the value false if the module doesn't support global search.
activity_badge boolean
Indicates the badge or icon associated with activities in the module.
$field_states jsonarray
Indicates the different states or conditions of fields within the module.
zia_view boolean
Indicates the availability of Zoho Intelligent Assistant (Zia) for the module.
email_parser_supported boolean
Has the value true if the module supports email parsing or the value false if the module doesn't support email parsing.
inventory_template_supported boolean
Has the value true if the module supports the inventory template or the value false if the module doesn't support the inventory template.
plural_label string
The plural label of the module. For example, Pipelines.
presence_sub_menu boolean
Has the value true if the module contains a sub-menu or the value false if the module doesn't contain a sub-menu.
triggers_supported boolean
Has the value true if the module supports triggers or the value false if the module doesn't support triggers.
id string
The unique identifier of the module.
per_page integer
Indicates the number of records displayed per page.
$properties jsonarray
Lists various properties or attributes associated with the module.
visible boolean
Has the value true if the module is visible to the current user's profile or the value false if the module is not visible.
visibility integer
Indicates the visibility of the module for the user. 1 means when the module is visible. 0 means when the module is hidden. -1 means when the module is unavailable or hidden by the system due to the plan downgrade.
emailTemplate_support boolean
Has the value true if the module supports an email template or the value false if the module doesn't support an email template.
profiles jsonarray
Lists various profiles that have access to the module.
filter_supported boolean
In some cases, the module supports custom filters beside the system-defined filters in a custom view. Has the value true if the module supports the custom filter or the value false if the module doesn't support the custom filter.
$on_demand_properties jsonarray
Lists properties that are available on-demand.
kanban_view_supported boolean
Has the value true if the module supports the kanban view or the value false if the module doesn't support the kanban view.
web_link string
Indicates the web link of the module.
lookup_field_properties jsonobject
Contains properties related to lookup fields within the module.
fields jsonarray
Lists lookup fields that are available in the module.
viewable boolean
Has the value true if the user can view records in the module or the value false if the user can't view records in the module.
api_name string
Indicates the API name of the module. For example, the API name of the Companies module is Accounts.
module_name string
Indicates the display name of the module.
custom_view jsonobject
Indicates custom view details within the module.
parent_module jsonobject
The JSON object contains the details of the parent module.
has_more_profiles boolean
Has the value true if there are additional profiles available for a module or the value false if there no additional profiles for a module.
kanban_view boolean
Indicates the availability of kanban view within the module.
deletable boolean
Has the value true if the user can delete a record in the module or the value false if the user can't delete a record in the module.
description string
Indicates the description of the module.
creatable boolean
Has the value true if the user can create records in the module or the value false if the user can't create records in the module.
filter_status boolean
Has the value true if the module supports advance filtering functionality or the value false if the module doesn't support advance filtering functionality.
modified_time datetime
Indicates the date and time (ISO8601) of the most recent modifications performed in module properties.
isBlueprintSupported boolean
Has the value true if the module supports Blueprint or the value false if the module doesn't support Blueprint.
related_list_properties jsonobject
Contains properties related to the related lists in the module.
sort_by string
Indicates the field for sorting records.
fields jsonarray
Lists available fields in the module.
sort_order string
Indicates the order of the records. It can be asc for ascending order and desc for descending order.
convertable boolean
Has the value true if the user can convert a record into another type of record or the value false if the user can't convert a record into another type of record.
editable boolean
Has the value true if the user can edit a record in the module or the value false if the user can't edit a record in the module.
display_field string
Indicates the field used as the primary display field for records in the module.
search_layout_fields jsonarray
Lists the fields used in the search layout for the module.
show_as_tab boolean
Has the value true if the module appears as a tab in Bigin or the value false if the module doesn't appear as a tab in Bigin.
sequence_number integer
Indicates the position of the module in Bigin.
singular_label string
The singular label of the module. For example, Pipeline.
api_supported boolean
Has the value true if the module is accessible through API or the value false if the module doesn't accessible through API.
quick_create boolean
Has the value true if the module supports the quick create action or the value false if the module doesn't support the quick create action. The quick create action is used to create records instantly in modules.
modified_by jsonobject
The JSON object contains the user details who have performed the most recent modifications of the module properties.
generated_type string
Indicates how the module is created.
- default - A module that is generated as default. For example, Pipelines, Contacts, Accounts, and so on.
- linking - A module that is generated as linking module.
- subform - A module that is generated as subform.
- web - A module that is generated as web-tab widget.
- custom - A module that is generated as custom module.
feeds_required boolean
Has the value true if the module contains feeds or the value false if the module doesn't contain feeds.
scoring_supported boolean
Has the value true if the module qualifies for the scoring process or the value false if the module doesn't qualify for the scoring process.
webform_supported boolean
Has the value true if the module supports the web form or the value false if the module doesn't support the web form.
arguments jsonarray
Lists the parameters for the link used in the web tab. Each object has a display name and the value of the argument.
profile_count integer
Indicates the count or number of profiles associated with a module.
business_card_field_limit integer
Indicates the maximum number of fields that can be allowed in a business card.
Possible error codes
The response of this resource includes HTTP status and error codes.
The most common HTTP error codes that occur when you request access to this endpoint are given in the following:
- INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name. - INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.
Sample response
Copied{
"modules": [
{
"global_search_supported": true,
"activity_badge": "Enabled",
"$field_states": [
"convert_scheduler"
],
"zia_view": false,
"email_parser_supported": false,
"inventory_template_supported": false,
"plural_label": "Pipelines",
"presence_sub_menu": true,
"triggers_supported": true,
"id": "2034020000000000131",
"per_page": 20,
"$properties": [
"$approval_state",
"$state",
"$currency_symbol",
"$zia_owner_assignment",
"$review",
"$review_process",
"$approval",
"$in_merge",
"$followed",
"$followers",
"$process_flow",
"$orchestration",
"$pathfinder",
"$zia_visions",
"$editable",
"$field_states"
],
"visible": true,
"visibility": 1,
"emailTemplate_support": true,
"profiles": [
{
"name": "Administrator",
"id": "2034020000000015972"
},
{
"name": "Standard",
"id": "2034020000000015975"
}
],
"filter_supported": true,
"$on_demand_properties": [
"$blocked_reason"
],
"kanban_view_supported": true,
"web_link": null,
"lookup_field_properties": {
"fields": [
{
"sequence_number": 1,
"api_name": "Deal_Name",
"id": "2034020000000000519"
},
{
"sequence_number": 2,
"api_name": "Amount",
"id": "2034020000000000517"
},
{
"sequence_number": 3,
"api_name": "Stage",
"id": "2034020000000000525"
},
{
"sequence_number": 4,
"api_name": "Closing_Date",
"id": "2034020000000000521"
},
{
"sequence_number": 5,
"api_name": "Account_Name",
"id": "2034020000000000523"
},
{
"sequence_number": 6,
"api_name": "Contact_Name",
"id": "2034020000000000539"
},
{
"sequence_number": 7,
"api_name": "Owner",
"id": "2034020000000000515"
}
]
},
"viewable": true,
"api_name": "Pipelines",
"module_name": "Pipelines",
"custom_view": {
"display_value": "All Potentials",
"created_time": null,
"access_type": "public",
"criteria": {
"comparator": "equal",
"field": {
"api_name": "Layout",
"id": "2034020000000098017"
},
"value": {
"name": "Sales - Marketing",
"id": "2034020000000095023"
}
},
"system_name": "ALLVIEWS",
"sort_by": null,
"created_by": null,
"shared_to": null,
"default": true,
"modified_time": null,
"name": "All Potentials",
"system_defined": true,
"modified_by": null,
"id": "2034020000000091545",
"fields": [
{
"api_name": "Deal_Name",
"_pin": false,
"id": "2034020000000000519"
},
{
"api_name": "Amount",
"_pin": false,
"id": "2034020000000000517"
},
{
"api_name": "Stage",
"_pin": false,
"id": "2034020000000000525"
},
{
"api_name": "Closing_Date",
"_pin": false,
"id": "2034020000000000521"
},
{
"api_name": "Account_Name",
"_pin": false,
"id": "2034020000000000523"
},
{
"api_name": "Contact_Name",
"_pin": false,
"id": "2034020000000000539"
},
{
"api_name": "Owner",
"_pin": false,
"id": "2034020000000000515"
}
],
"category": "public_views",
"last_accessed_time": "2023-06-20T16:37:31+05:30",
"locked": false,
"sort_order": null,
"favorite": null
},
"parent_module": {},
"has_more_profiles": false,
"kanban_view": true,
"deletable": true,
"description": null,
"creatable": true,
"filter_status": true,
"modified_time": "2023-05-10T19:28:46+05:30",
"isBlueprintSupported": true,
"related_list_properties": {
"sort_by": null,
"fields": [
"Deal_Name",
"Amount",
"Stage",
"Closing_Date"
],
"sort_order": null
},
"convertable": false,
"editable": true,
"display_field": "Deal_Name",
"search_layout_fields": [
"Owner",
"Amount",
"Deal_Name",
"Closing_Date",
"Account_Name",
"Stage",
"Contact_Name",
"Layout",
"Pipeline"
],
"show_as_tab": true,
"sequence_number": 5,
"singular_label": "Pipeline",
"api_supported": true,
"quick_create": true,
"modified_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"generated_type": "default",
"feeds_required": true,
"scoring_supported": true,
"webform_supported": true,
"arguments": [],
"profile_count": 2,
"business_card_field_limit": 5
}
]
}