Modules API
Overview
In Bigin, data is organized into different modules. Each module represents a specific business aspect and performs different operations to achieve a common business goal. Also, each module stores a specific type of data. For example, the contacts module can have information about customers, whereas the companies module can have information about customers' organizations.
In general, the Bigin account has the following modules: pipelines, contacts, companies, products, events, tasks, associate products, notes and attachments.
Endpoints
Get a list of modules
Retrieves the list of modules available in an organization.
- When you access this resource, refer to api_name in the response object. Each module field has an API name that you can use for third-party integration.
- The api_name can be used when you insert, update, or upsert records to a specified module.
- The api_name must consist of alphabets, numbers, and underscores. It should start with an alphabet and should not have consecutive underscores or end with an underscore.
- The api_name for the Companies module in Bigin is Accounts.
Request URL
{api-domain}/bigin/v2/settings/modules
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.ALL
- ZohoBigin.settings.modules.ALL
- ZohoBigin.settings.modules.READ
Request parameters
The request parameters aren't available for this endpoint.
Response object
The response object contains a list of available modules with the following details:
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.
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.
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. If the description isn't available, the field displays Null.
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.
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.
modified_time datetime in ISO8601 format
Indicates the date and time (ISO8601) of the most recent modifications performed in module properties.
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.
isBlueprintSupported boolean
Has the value true if the module supports Blueprint or the value false if the module doesn't support Blueprint.
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.
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.
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
The array object contains the 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.
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.
web_link string
Indicates the web link of the module.
sequence_number integer
Indicates the position of the module in Bigin.
singular_label string
The singular label of the module. For example, Pipeline.
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_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.
api_name string
Indicates the API name of the module. For example, the API name of the Companies module is Accounts.
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
The array object contains the parameters for the link used in the web tab. Each object has a display name and the value of the argument.
module_name string
Indicates the display name of the module.
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.
parent_module jsonobject
The JSON object contains the details of the parent module.
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:
Not Found 404
INVALID_URL_PATTERN
Message: Please check if the URL trying to access is a correct one
Resolution: The specified request URL is incorrect. Check and provide the valid request URL as given above.
Unauthorized 401
OAUTH_SCOPE_MISMATCH
Message: invalid oauth scope to access this URL
Resolution: Authorize the client and generate access tokens with valid scopes. Check the scopes section specified above to know the supported scopes for this endpoint.
Forbidden 403
NO_PERMISSION
Message: Permission denied to read
Resolution: The client doesn't have permission to view this resource. Contact the system administrator.
Bad Request 400
INVALID_REQUEST_METHOD
Message: The http request method type is not a valid one
Resolution: The specified HTTP method is incorrect. Check and provide the valid HTTP request method as given above.
AUTHORIZATION_FAILED
Message: User does not have sufficient privilege to read module details
Resolution: The client doesn't have permission to retrieve this resource. Contact the system administrator.
Sample response
Copied{
"modules": [
{
"has_more_profiles": false,
"global_search_supported": true,
"deletable": true,
"description": null,
"creatable": true,
"email_parser_supported": true,
"inventory_template_supported": false,
"modified_time": null,
"plural_label": "Contacts",
"presence_sub_menu": true,
"triggers_supported": true,
"id": "2034020000000000129",
"isBlueprintSupported": true,
"visible": true,
"visibility": 1,
"convertable": false,
"editable": true,
"emailTemplate_support": true,
"profiles": [
{
"name": "Administrator",
"id": "2034020000000015972"
},
{
"name": "Standard",
"id": "2034020000000015975"
}
],
"filter_supported": true,
"show_as_tab": true,
"web_link": null,
"sequence_number": 3,
"singular_label": "Contact",
"viewable": true,
"api_supported": true,
"api_name": "Contacts",
"quick_create": true,
"modified_by": null,
"generated_type": "default",
"feeds_required": true,
"scoring_supported": true,
"webform_supported": true,
"arguments": [],
"module_name": "Contacts",
"profile_count": 2,
"business_card_field_limit": 5,
"parent_module": {}
},
{
"has_more_profiles": false,
"global_search_supported": true,
"deletable": true,
"description": null,
"creatable": true,
"email_parser_supported": true,
"inventory_template_supported": false,
"modified_time": "2023-04-11T17:00:27+05:30",
"plural_label": "Companies",
"presence_sub_menu": true,
"triggers_supported": true,
"id": "2034020000000000127",
"isBlueprintSupported": true,
"visible": true,
"visibility": 1,
"convertable": false,
"editable": true,
"emailTemplate_support": true,
"profiles": [
{
"name": "Administrator",
"id": "2034020000000015972"
},
{
"name": "Standard",
"id": "2034020000000015975"
}
],
"filter_supported": true,
"show_as_tab": true,
"web_link": null,
"sequence_number": 4,
"singular_label": "Company",
"viewable": true,
"api_supported": true,
"api_name": "Accounts",
"quick_create": true,
"modified_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"generated_type": "default",
"feeds_required": true,
"scoring_supported": true,
"webform_supported": false,
"arguments": [],
"module_name": "Accounts",
"profile_count": 2,
"business_card_field_limit": 5,
"parent_module": {}
},
{
"has_more_profiles": false,
"global_search_supported": true,
"deletable": true,
"description": null,
"creatable": true,
"email_parser_supported": false,
"inventory_template_supported": false,
"modified_time": "2023-05-10T19:28:46+05:30",
"plural_label": "Pipelines",
"presence_sub_menu": true,
"triggers_supported": true,
"id": "2034020000000000131",
"isBlueprintSupported": true,
"visible": true,
"visibility": 1,
"convertable": false,
"editable": true,
"emailTemplate_support": true,
"profiles": [
{
"name": "Administrator",
"id": "2034020000000015972"
},
{
"name": "Standard",
"id": "2034020000000015975"
}
],
"filter_supported": true,
"show_as_tab": true,
"web_link": null,
"sequence_number": 5,
"singular_label": "Pipeline",
"viewable": true,
"api_supported": true,
"api_name": "Pipelines",
"quick_create": true,
"modified_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"generated_type": "default",
"feeds_required": true,
"scoring_supported": true,
"webform_supported": true,
"arguments": [],
"module_name": "Pipelines",
"profile_count": 2,
"business_card_field_limit": 5,
"parent_module": {}
},
{
"has_more_profiles": false,
"global_search_supported": true,
"deletable": true,
"description": null,
"creatable": true,
"email_parser_supported": false,
"inventory_template_supported": false,
"modified_time": null,
"plural_label": "Tasks",
"presence_sub_menu": true,
"triggers_supported": true,
"id": "2034020000000000143",
"isBlueprintSupported": true,
"visible": true,
"visibility": 1,
"convertable": false,
"editable": true,
"emailTemplate_support": true,
"profiles": [
{
"name": "Administrator",
"id": "2034020000000015972"
},
{
"name": "Standard",
"id": "2034020000000015975"
}
],
"filter_supported": true,
"show_as_tab": true,
"web_link": null,
"sequence_number": 6,
"singular_label": "Task",
"viewable": true,
"api_supported": true,
"api_name": "Tasks",
"quick_create": true,
"modified_by": null,
"generated_type": "default",
"feeds_required": true,
"scoring_supported": false,
"webform_supported": false,
"arguments": [],
"module_name": "Tasks",
"profile_count": 2,
"business_card_field_limit": 5,
"parent_module": {}
},
{
"has_more_profiles": false,
"global_search_supported": true,
"deletable": true,
"description": null,
"creatable": true,
"email_parser_supported": false,
"inventory_template_supported": false,
"modified_time": null,
"plural_label": "Events",
"presence_sub_menu": true,
"triggers_supported": true,
"id": "2034020000000000145",
"isBlueprintSupported": true,
"visible": true,
"visibility": 1,
"convertable": false,
"editable": true,
"emailTemplate_support": true,
"profiles": [
{
"name": "Administrator",
"id": "2034020000000015972"
},
{
"name": "Standard",
"id": "2034020000000015975"
}
],
"filter_supported": true,
"show_as_tab": true,
"web_link": null,
"sequence_number": 6,
"singular_label": "Event",
"viewable": true,
"api_supported": true,
"api_name": "Events",
"quick_create": true,
"modified_by": null,
"generated_type": "default",
"feeds_required": true,
"scoring_supported": false,
"webform_supported": false,
"arguments": [],
"module_name": "Events",
"profile_count": 2,
"business_card_field_limit": 5,
"parent_module": {}
},
{
"has_more_profiles": false,
"global_search_supported": true,
"deletable": true,
"description": null,
"creatable": true,
"email_parser_supported": false,
"inventory_template_supported": false,
"modified_time": null,
"plural_label": "Calls",
"presence_sub_menu": true,
"triggers_supported": true,
"id": "2034020000000017015",
"isBlueprintSupported": false,
"visible": true,
"visibility": 1,
"convertable": false,
"editable": true,
"emailTemplate_support": true,
"profiles": [
{
"name": "Administrator",
"id": "2034020000000015972"
},
{
"name": "Standard",
"id": "2034020000000015975"
}
],
"filter_supported": true,
"show_as_tab": true,
"web_link": null,
"sequence_number": 6,
"singular_label": "Call",
"viewable": true,
"api_supported": true,
"api_name": "Calls",
"quick_create": true,
"modified_by": null,
"generated_type": "default",
"feeds_required": true,
"scoring_supported": false,
"webform_supported": false,
"arguments": [],
"module_name": "Calls",
"profile_count": 2,
"business_card_field_limit": 5,
"parent_module": {}
},
{
"has_more_profiles": false,
"global_search_supported": true,
"deletable": true,
"description": null,
"creatable": true,
"email_parser_supported": false,
"inventory_template_supported": false,
"modified_time": null,
"plural_label": "Products",
"presence_sub_menu": true,
"triggers_supported": true,
"id": "2034020000000000163",
"isBlueprintSupported": true,
"visible": true,
"visibility": 1,
"convertable": false,
"editable": true,
"emailTemplate_support": true,
"profiles": [
{
"name": "Administrator",
"id": "2034020000000015972"
},
{
"name": "Standard",
"id": "2034020000000015975"
}
],
"filter_supported": true,
"show_as_tab": true,
"web_link": null,
"sequence_number": 9,
"singular_label": "Product",
"viewable": true,
"api_supported": true,
"api_name": "Products",
"quick_create": true,
"modified_by": null,
"generated_type": "default",
"feeds_required": true,
"scoring_supported": false,
"webform_supported": false,
"arguments": [],
"module_name": "Products",
"profile_count": 2,
"business_card_field_limit": 5,
"parent_module": {}
},
{
"has_more_profiles": false,
"global_search_supported": false,
"deletable": false,
"description": null,
"creatable": false,
"email_parser_supported": false,
"inventory_template_supported": false,
"modified_time": null,
"plural_label": "Social",
"presence_sub_menu": false,
"triggers_supported": false,
"id": "2034020000000048001",
"isBlueprintSupported": false,
"visible": true,
"visibility": 1,
"convertable": false,
"editable": false,
"emailTemplate_support": false,
"profiles": [
{
"name": "Administrator",
"id": "2034020000000015972"
}
],
"filter_supported": false,
"show_as_tab": true,
"web_link": null,
"sequence_number": 24,
"singular_label": "Social",
"viewable": true,
"api_supported": false,
"api_name": "Social",
"quick_create": false,
"modified_by": null,
"generated_type": "default",
"feeds_required": false,
"scoring_supported": false,
"webform_supported": false,
"arguments": [],
"module_name": "Social",
"profile_count": 1,
"business_card_field_limit": 5,
"parent_module": {}
},
{
"has_more_profiles": false,
"global_search_supported": true,
"deletable": true,
"description": null,
"creatable": false,
"email_parser_supported": false,
"inventory_template_supported": false,
"modified_time": "2023-04-11T17:00:34+05:30",
"plural_label": "Associated Products",
"presence_sub_menu": false,
"triggers_supported": false,
"id": "2034020000000458818",
"isBlueprintSupported": false,
"visible": true,
"visibility": 2,
"convertable": false,
"editable": false,
"emailTemplate_support": false,
"profiles": [
{
"name": "Administrator",
"id": "2034020000000015972"
},
{
"name": "Standard",
"id": "2034020000000015975"
}
],
"filter_supported": false,
"show_as_tab": false,
"web_link": null,
"sequence_number": 25,
"singular_label": "Associated Products",
"viewable": true,
"api_supported": true,
"api_name": "Associated_Products",
"quick_create": false,
"modified_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"generated_type": "subform",
"feeds_required": false,
"scoring_supported": false,
"webform_supported": false,
"arguments": [],
"module_name": "LinkingModule1",
"profile_count": 2,
"business_card_field_limit": 5,
"parent_module": {
"api_name": "Deals",
"id": "2034020000000000131"
}
},
{
"has_more_profiles": false,
"global_search_supported": true,
"deletable": true,
"description": null,
"creatable": true,
"email_parser_supported": false,
"inventory_template_supported": false,
"modified_time": null,
"plural_label": "Notes",
"presence_sub_menu": false,
"triggers_supported": false,
"id": "2034020000000000147",
"isBlueprintSupported": false,
"visible": false,
"visibility": 1,
"convertable": false,
"editable": true,
"emailTemplate_support": false,
"profiles": [
{
"name": "Administrator",
"id": "2034020000000015972"
},
{
"name": "Standard",
"id": "2034020000000015975"
}
],
"filter_supported": false,
"show_as_tab": false,
"web_link": null,
"sequence_number": 29,
"singular_label": "Note",
"viewable": true,
"api_supported": true,
"api_name": "Notes",
"quick_create": false,
"modified_by": null,
"generated_type": "default",
"feeds_required": false,
"scoring_supported": false,
"webform_supported": false,
"arguments": [],
"module_name": "Notes",
"profile_count": 2,
"business_card_field_limit": 5,
"parent_module": {}
},
{
"has_more_profiles": false,
"global_search_supported": false,
"deletable": true,
"description": null,
"creatable": true,
"email_parser_supported": false,
"inventory_template_supported": false,
"modified_time": null,
"plural_label": "Attachments",
"presence_sub_menu": false,
"triggers_supported": false,
"id": "2034020000000000177",
"isBlueprintSupported": false,
"visible": false,
"visibility": 1,
"convertable": false,
"editable": false,
"emailTemplate_support": false,
"profiles": [
{
"name": "Administrator",
"id": "2034020000000015972"
},
{
"name": "Standard",
"id": "2034020000000015975"
}
],
"filter_supported": false,
"show_as_tab": false,
"web_link": null,
"sequence_number": 33,
"singular_label": "Attachment",
"viewable": true,
"api_supported": true,
"api_name": "Attachments",
"quick_create": false,
"modified_by": null,
"generated_type": "default",
"feeds_required": false,
"scoring_supported": false,
"webform_supported": false,
"arguments": [],
"module_name": "Attachments",
"profile_count": 2,
"business_card_field_limit": 5,
"parent_module": {}
}
]
}