Modules API

Bigin has modules such as Contacts, Deals, Products, Activities, and so on. Using Bigin REST API, you can retrieve the list of available modules through the Get List of Modules API.

Get List of Modules

Purpose

To retrieve the list of all the modules available in your Bigin account.

Request Details

Request URL

https://www.zohoapis.com/bigin/v1/settings/modules

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoBigin.settings.ALL
(or)
scope=ZohoBigin.settings.modules.{operation_type}

Possible operation types

ALL - Full data access
READ - Get module data

Note
  • Refer the key api_name in the JSON data while accessing the resource. Every module, field and related lists will have an API name, which you can use in third party integrations. For example, if you want to access the Contacts module, use “Contacts" as the api_name every time you access the resource. Please note that you cannot alter the API Names for the default fields.

  • The generated API name can contain only alphabets, numbers, and underscore. The API name should start with an alphabet and should not have two consecutive underscores or end with an underscore.

  • Refer Response Structure for more details about the JSON keys, values, and their descriptions of the available modules. You can also use the sample response of each module as the input when you insert, update, or upsert a record in that corresponding module.

  • Accounts in API refers to Companies module in Bigin.

Sample Request

Copiedcurl "https://www.zohoapis.com/bigin/v1/settings/modules"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"

Response JSON Keys

  • global_search_supportedboolean

    Represents if the current module has global search support.
    Possible values- true: The current module has global search support.
    false: The current module does not have global search support.

  • deletableboolean

    Describes if the user can delete a record in the current module.
    Possible values- true: The user can delete a record in the current module.
    false: The user cannot delete a record in the current module.

  • descriptionstring

    Represents the description of the module, if any.

  • creatableboolean

    Represents if the user can create records in the current module.
    Possible values- true: The user can create records in the current module.
    false: The user cannot create records in the current module.

  • modified_timedate and time in ISO8601 format

    Represents the date and time of when the module properties were last modified.

  • plural_labelstring

    Represents the plural of the module name. Example: Leads.

  • singular_labelstring

    Represents the singular of the module name. Example: Lead.

  • presence_sub_menuboolean

    Represents if the module has a submenu. For instance, Tasks in Activities is a submenu.
    Possible values- true: The current module has a submenu.
    false: The current module does not have a submenu.

  • triggers_supportedboolean

    Represents if the module supports triggers from workflows etc.
    Possible values- true: The current module supports triggers. For instance, Contacts, Accounts,and so on.
    false: The current module does not support triggers. For instance, Activities, Feeds, and so on.

  • idstring

    Represents the unique ID of the module. For instance, 4150868000000002173

  • visibilityinteger

    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.

  • viewableboolean
  • Represents if the user can view the records in the current module.
    Possible values- true: The user can view the records in the current module.
    false: The user cannot view the records in the current module.

  • editableboolean

    Describes if the user can edit a record in the current module.
    Possible values- true: The user can edit a record in the current module.
    false: The user cannot edit a record in the current module.

  • emailTemplate_supportboolean

    Represents if the module supports the usage of the email templates.
    Possible values- true: The module has email template support.
    false: The module does not have email template support.

  • api_supportedboolean

    Describes if the current module is accessible via API.
    Possible values- true: The current module is accessible via API. For instance, Contacts, Accounts.
    false: The current module is not accessible via API. For instance, Feeds and so on.

  • profilesJSON array

    Each object in the array represents the details of the profile that has access to the module. Example: {
    "name": "Administrator",
    "id": "4150868000000026011"
    },

  • filter_supportedboolean

    Represents if the module supports custom filters besides the system-defined ones in a custom view.
    Possible values- true: The current module has custom-filter support.
    false: The current module does not have custom-filter support.

  • sequence_numberinteger

    Represents the position of the module in the Bigin.

  • api_namestring

    Represents the API name of the module. Example: Leads.

  • quick_createboolean

    Represents if the module supports quick create.
    Possible values- true: The user can add records using quick create in the current module. For instance, Contacts, Accounts, and so on.
    false: The user cannot add records using quick create in the current module. For instance, Feeds, Forecasts, and so on.

  • modified_byJSON object

    Represents the name and ID of the user who last modified the module properties. For example: "modified_by": {
    "name": "Patricia Boyle",
    "id": "4150868000000225013"
    }

  • generated_typestring

    Represents how the module was created.
    Possible values- default: It is a default module. For instance, Contacts, Accounts, and so on.
    linking: It is a linking module.

  • feeds_requiredboolean

    Represents if feeds is enabled for the module.
    Possible values- true: Feeds is enabled for the current module.
    false: Feeds is not enabled for the current module.

  • webform_supportedboolean

    Represents if the records in the module can be created via web forms.
    Possible values- true: The current module supports webforms.
    false: The current module does not support webforms.

  • module_namestring

    Represents the display name of the module.

    parent_moduleJSON object

  • Represents the details of the parent module, if any. For instance, Activities is the parent module for Tasks, Calls, and Events.

Possible Errors

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoBigin.settings.modules.READ scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to read
    Resolution: The user does not have permission to read records. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in the server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to read module details.
    Resolution: The user does not have the permission to retrieve module details. Contact your system administrator.

Copied{
    "modules": [
        {
            "global_search_supported": true,
            "deletable": true,
            "description": null,
            "creatable": true,
            "modified_time": "2020-01-27T14:44:05+05:30",
            "plural_label": "Contacts",
            "presence_sub_menu": true,
            "triggers_supported": true,
            "id": "3815646000000002179",
            "visibility": 1,
            "convertable": false,
            "editable": true,
            "emailTemplate_support": true,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "3815646000000026011"
                },
                {
                    "name": "Standard",
                    "id": "3815646000000026014"
                },
            ],
            "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": {
                "name": "Patricia",
                "id": "3815646000000196013"
            },
            "generated_type": "default",
            "feeds_required": true,
            "webform_supported": true,
      		"module_name": "Contacts",
            "parent_module": {}
        },
        {
            "global_search_supported": true,
            "deletable": true,
            "description": null,
            "creatable": true,
            "modified_time": "2020-05-04T15:01:20+05:30",
            "plural_label": "Companies",
            "presence_sub_menu": true,
            "triggers_supported": true,
            "id": "3815646000000002177",
            "visibility": 1,
            "convertable": false,
            "editable": true,
            "emailTemplate_support": true,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "3815646000000026011"
                },
                {
                    "name": "Standard",
                    "id": "3815646000000026014"
                },
            ],
            "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": "Patricia",
                "id": "3815646000000196013"
            },
            "generated_type": "default",
            "feeds_required": true,   
            "webform_supported": false,          
            "module_name": "Accounts",
            "parent_module": {}
        },
        {
            "global_search_supported": true,
            "deletable": true,
            "description": null,
            "creatable": true,
            "modified_time": "2020-10-15T09:48:43+05:30",
            "plural_label": "Deals",
            "presence_sub_menu": true,
            "triggers_supported": true,
            "id": "3815646000000002181",
            "visibility": 1,
            "convertable": false,
            "editable": true,
            "emailTemplate_support": true,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "3815646000000026011"
                },
            ],
            "filter_supported": true,
            "show_as_tab": true,
            "web_link": null,
            "sequence_number": 5,
            "singular_label": "Deal",
            "viewable": true,
            "api_supported": true,
            "api_name": "Deals",
            "quick_create": true,
            "modified_by": {
                "name": "Patricia",
                "id": "3815646000000196013"
            },
            "generated_type": "default",
            "feeds_required": true,
            "webform_supported": false,
          	"module_name": "Deals",
            "parent_module": {}
        },
        {
            "global_search_supported": false,
            "deletable": true,
            "description": null,
            "creatable": true,
            "modified_time": "2020-02-14T20:07:50+05:30",
            "plural_label": "Activities",
            "presence_sub_menu": false,
            "triggers_supported": false,
            "id": "3815646000000002203",
            "visibility": 1,
            "convertable": false,
            "editable": true,
            "emailTemplate_support": false,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "3815646000000026011"
                },
                {
                    "name": "Standard",
                    "id": "3815646000000026014"
                },
            ],
            "filter_supported": true,
            "show_as_tab": true,
            "web_link": null,
            "sequence_number": 6,
            "singular_label": "Activity",
            "viewable": true,
            "api_supported": true,
            "api_name": "Activities",
            "quick_create": false,
            "modified_by": {
                "name": "Patricia",
                "id": "3815646000000196013"
            },
            "generated_type": "default",
            "feeds_required": true,
            "webform_supported": false,
            "module_name": "Activities",
            "parent_module": {}
        },
        {
            "global_search_supported": true,
            "deletable": true,
            "description": null,
            "creatable": true,
            "modified_time": "2020-01-29T18:54:01+05:30",
            "plural_label": "Products",
            "presence_sub_menu": true,
            "triggers_supported": true,
            "id": "3815646000000002213",
            "visibility": 1,
            "convertable": false,
            "editable": true,
            "emailTemplate_support": true,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "3815646000000026011"
                },
                {
                    "name": "Standard",
                    "id": "3815646000000026014"
                }
            ],
            "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": {
                "name": "Patricia",
                "id": "3815646000000196013"
            },
            "generated_type": "default",
            "feeds_required": false,
         	"webform_supported": false,
            "module_name": "Products",
            "parent_module": {}
        },
        {
            "global_search_supported": false,
            "deletable": false,
            "description": null,
            "creatable": false,
            "modified_time": null,
            "plural_label": "Social",
            "presence_sub_menu": false,
            "triggers_supported": false,
            "id": "3815646000000065001",
            "visibility": 1,
            "convertable": false,
            "editable": false,
            "emailTemplate_support": false,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "3815646000000026011"
                },
                {
                    "name": "Standard",
                    "id": "3815646000000026014"
                },
            ],
            "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,
            "webform_supported": false,
         	"module_name": "Social",
            "parent_module": {}
        },
        {
            "global_search_supported": true,
            "deletable": true,
            "description": null,
            "creatable": true,
            "modified_time": "2019-04-25T16:08:52+05:30",
            "plural_label": "Associated Products",
            "presence_sub_menu": false,
            "triggers_supported": false,
            "id": "3815646000000235012",
            "visibility": 2,
            "convertable": false,
            "editable": true,
            "emailTemplate_support": false,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "3815646000000026011"
                },
            ],
            "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": "Patricia",
                "id": "3815646000000196013"
            },
            "generated_type": "subform",
            "feeds_required": false,
            "webform_supported": false,
            "module_name": "LinkingModule1",
            "business_card_field_limit": 5,
            "parent_module": {
                "api_name": "Deals",
                "id": "3815646000000002181"
            }
        },
        {
            "global_search_supported": true,
            "deletable": true,
            "description": null,
            "creatable": true,
            "modified_time": null,
            "plural_label": "Tasks",
            "presence_sub_menu": true,
            "triggers_supported": true,
            "id": "3815646000000002193",
            "visibility": 1,
            "convertable": false,
            "editable": true,
            "emailTemplate_support": true,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "3815646000000026011"
                },
                {
                    "name": "Standard",
                    "id": "3815646000000026014"
                },
            ],
            "filter_supported": true,
            "show_as_tab": false,
            "web_link": null,
            "sequence_number": 27,
            "singular_label": "Task",
            "viewable": true,
            "api_supported": true,
            "api_name": "Tasks",
            "quick_create": true,
            "modified_by": null,
            "generated_type": "default",
            "feeds_required": true,
            "webform_supported": false,
            "module_name": "Tasks",
            "parent_module": {
                "api_name": "Activities",
                "id": "3815646000000002203"
            }
        },
        {
            "global_search_supported": true,
            "deletable": true,
            "description": null,
            "creatable": true,
            "modified_time": null,
            "plural_label": "Events",
            "presence_sub_menu": true,
            "triggers_supported": true,
            "id": "3815646000000002195",
  		"visibility": 1,
            "convertable": false,
            "editable": true,
            "emailTemplate_support": true,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "3815646000000026011"
                },
                {
                    "name": "Standard",
                    "id": "3815646000000026014"
                },
            ],
            "filter_supported": true,
            "show_as_tab": false,
            "web_link": null,
            "sequence_number": 28,
            "singular_label": "Event",
            "viewable": true,
            "api_supported": true,
            "api_name": "Events",
            "quick_create": true,
            "modified_by": null,
            "generated_type": "default",
            "feeds_required": true,
            "webform_supported": false,
            "module_name": "Events",
            "parent_module": {
                "api_name": "Activities",
                "id": "3815646000000002203"
            }
        },
        {
            "global_search_supported": true,
            "deletable": true,
            "description": null,
            "creatable": true,
            "modified_time": null,
            "plural_label": "Notes",
            "presence_sub_menu": false,
            "triggers_supported": false,
            "id": "3815646000000002197",
            "visibility": 1,
            "convertable": false,
            "editable": true,
            "emailTemplate_support": false,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "3815646000000026011"
                },
                {
                    "name": "Standard",
                    "id": "3815646000000026014"
                },   
            ],
            "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,
            "webform_supported": false,
            "module_name": "Notes",
            "parent_module": {}
        },
        {
            "global_search_supported": false,
            "deletable": true,
            "description": null,
            "creatable": true,
            "modified_time": null,
            "plural_label": "Attachments",
            "presence_sub_menu": false,
            "triggers_supported": false,
            "id": "3815646000000002227",
            "visibility": 1,
            "convertable": false,
            "editable": false,
            "emailTemplate_support": false,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "3815646000000026011"
                },
                {
                    "name": "Standard",
                    "id": "3815646000000026014"
                },
            ],
            "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,
            "webform_supported": false,
            "module_name": "Attachments",
            "parent_module": {}
        },
        {
            "global_search_supported": true,
            "deletable": true,
            "description": null,
            "creatable": true,
            "modified_time": "2019-07-28T04:39:04+05:30",
            "plural_label": "Calls",
            "presence_sub_menu": true,
            "triggers_supported": true,
            "id": "3815646000000033015",
            "visibility": 1,
            "convertable": false,
            "editable": true,
            "emailTemplate_support": true,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "3815646000000026011"
                },
                {
                    "name": "Standard",
                    "id": "3815646000000026014"
                },
            ],
            "filter_supported": true,
            "show_as_tab": false,
            "web_link": null,
            "sequence_number": 36,
            "singular_label": "Call",
            "viewable": true,
            "api_supported": true,
            "api_name": "Calls",
            "quick_create": true,
            "modified_by": null,
            "generated_type": "default",
            "feeds_required": true,
            "webform_supported": false,
            "module_name": "Calls",
            "parent_module": {
                "api_name": "Activities",
                "id": "3815646000000002203"
            }
        }
    ]
}