Get related lists metadata
Retrieve the related lists metadata of a module. The related lists metadata describes the related lists available in a module and their properties.
Request URL
Bigin APIs are available across eight different domains, and you must choose the one relevant to your data center (DC):
- US
- EU
- AU
- IN
- CN
- JP
- SA
- CA
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.related_lists.READ
- ZohoBigin.settings.related_lists.ALL
- ZohoBigin.settings.ALL
Request parameters
The available request parameters are given below:
Query parameters
module 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 |
Sample request
Copiedcurl "https://www.zohoapis.com/bigin/v2/settings/related_lists?module=Pipelines" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/bigin/v2/settings/related_lists?module=Pipelines"
type: GET
connection:"connection_link_name"
];
info response;Response object
The response object contains the following details:
module jsonobject
Contains the details about the module to which the related list belongs.
parent_related_lists string
Indicates the related lists associated with the parent entity.
type string
Indicates the type of the related list.
sequence_number integer
Indicates the sequence number for ordering the related lists.
display_label string
The display label or name assigned to the related list.
customize_sort boolean
Indicates whether sorting options can be customized for the related list or not.
customize_fields boolean
Indicates whether fields in the related list can be customized or not.
api_name string
The API name of the related list.
customize_display_label boolean
Indicates whether the display label for the related list can be customized or not.
name string
The name of the related list.
action string
Indicates the action or operation associated with the related list.
id string
The unique identification of the related list.
href string
Indicates the URL reference to access the related list.
pipelines jsonarray
Contains the details about the pipelines associated with the related list.
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{
"related_lists": [
{
"module": {
"api_name": "Notes",
"id": "2034020000000000147"
},
"parent_related_lists": null,
"type": "default",
"sequence_number": "1",
"display_label": "Notes",
"customize_sort": true,
"customize_fields": true,
"api_name": "Notes",
"customize_display_label": false,
"name": "Notes",
"action": null,
"id": "2034020000000002788",
"href": "Deals/{ENTITYID}/Notes"
},
{
"module": {
"api_name": "Emails",
"id": "2034020000000000179"
},
"parent_related_lists": null,
"type": "default",
"sequence_number": "3",
"display_label": "Emails",
"customize_sort": true,
"customize_fields": false,
"api_name": "Emails",
"customize_display_label": false,
"name": "Emails",
"action": null,
"id": "2034020000000002800",
"href": null
},
{
"module": {
"api_name": "DealHistory",
"id": "2034020000000205001"
},
"parent_related_lists": null,
"type": "default",
"sequence_number": "4",
"display_label": "Stage History",
"customize_sort": false,
"customize_fields": true,
"api_name": "Stage_History",
"customize_display_label": false,
"name": "Stage History",
"action": "picklist_tracker",
"id": "2034020000000002790",
"href": "Deals/{ENTITYID}/Stage_History"
},
{
"module": {
"api_name": "Attachments",
"id": "2034020000000000177"
},
"parent_related_lists": null,
"type": "default",
"sequence_number": "5",
"display_label": "Attachments",
"customize_sort": true,
"customize_fields": false,
"api_name": "Attachments",
"customize_display_label": false,
"name": "Attachments",
"action": null,
"id": "2034020000000002784",
"href": "Deals/{ENTITYID}/Attachments"
},
{
"module": {
"api_name": "Products",
"id": "2034020000000000163"
},
"parent_related_lists": null,
"type": "default",
"sequence_number": "6",
"display_label": "Products",
"customize_sort": true,
"customize_fields": true,
"api_name": "Products",
"customize_display_label": false,
"name": "Products",
"action": null,
"id": "2034020000000002792",
"href": "Deals/{ENTITYID}/Products"
},
{
"module": {
"api_name": "Pipelines_X_Contacts",
"id": "2034020000000461856"
},
"parent_related_lists": null,
"type": "multiselectlookup",
"connectedmodule": "Contacts",
"linkingmodule": "LinkingModule2",
"sequence_number": "11",
"display_label": "Contacts",
"pipelines": [
{
"name": "Real Estate",
"id": "2034020000000549001"
}
],
"customize_sort": true,
"customize_fields": true,
"api_name": "Contacts2",
"customize_display_label": true,
"name": "Contacts",
"action": null,
"id": "2034020000000461983",
"href": "Deals/{ENTITYID}/Contacts2"
},
{
"module": {
"api_name": "Locking_Information__s",
"id": "2034020000000419001"
},
"parent_related_lists": null,
"type": "default",
"sequence_number": "16",
"display_label": "Locking Information",
"customize_sort": false,
"customize_fields": false,
"api_name": "Locking_Information__s",
"customize_display_label": false,
"name": "Locking Information",
"action": null,
"id": "2034020000000419110",
"href": "Deals/{ENTITYID}/Locking_Information__s"
}
]
}