Custom

GET {{api-domain}}/crm/v2.1/settings/related_lists?module={{Custom_module_API_name}}

To get the metadata of the custom module.

Request Params

RESPONSES

status: OK

{"related_lists":[{"sequence_number":"1","display_label":"Lead Status History","api_name":"Lead_Status_History","module":"Lead_Status_History","name":"Lead Status History","action":"picklist_tracker","id":"4150868000004783320","href":"Leads/{ENTITYID}/Lead_Status_History","type":"default"},{"sequence_number":"1","display_label":"Notes","api_name":"Notes","module":"Notes","name":"Notes","action":null,"id":"4150868000000015122","href":"Leads/{ENTITYID}/Notes","type":"default"},{"sequence_number":"2","display_label":"Attachments","api_name":"Attachments","module":"Attachments","name":"Attachments","action":null,"id":"4150868000000003771","href":"Leads/{ENTITYID}/Attachments","type":"default"},{"sequence_number":"3","display_label":"Products","api_name":"Products","module":"Products","name":"Products","action":null,"id":"4150868000000003773","href":"Leads/{ENTITYID}/Products","type":"default"},{"sequence_number":"4","display_label":"Open Activities","api_name":"Activities","module":"Activities","name":"Activities","action":null,"id":"4150868000000003769","href":"Leads/{ENTITYID}/Activities","type":"default"},{"sequence_number":"5","display_label":"Closed Activities","api_name":"Activities_History","module":"Activities","name":"Activities History","action":null,"id":"4150868000000003767","href":"Leads/{ENTITYID}/Activities_History","type":"default"},{"sequence_number":"6","display_label":"Emails","api_name":"Emails","module":"Emails","name":"Emails","action":null,"id":"4150868000000014410","href":null,"type":"default"},{"sequence_number":"7","display_label":"Invited Meetings","api_name":"Invited_Events","module":"Events","name":"Invited Events","action":null,"id":"4150868000000062001","href":"Leads/{ENTITYID}/Invited_Events","type":"default"},{"sequence_number":"8","display_label":"Campaigns","api_name":"Campaigns","module":"Campaigns","name":"Campaigns","action":null,"id":"4150868000000040017","href":"Leads/{ENTITYID}/Campaigns","type":"default"},{"sequence_number":"9","display_label":"Social","api_name":"Social","module":"Social","name":"Social","action":null,"id":"4150868000000065003","href":null,"type":"default"},{"sequence_number":"10","display_label":"Checklists","api_name":"CheckLists","module":"CheckLists","name":"CheckLists","action":null,"id":"4150868000000141005","href":"Leads/{ENTITYID}/CheckLists","type":"default"},{"sequence_number":"11","display_label":"Accounts1","api_name":"Accounts15","module":"Leads_X_Accounts","name":"Accounts1","action":null,"id":"4150868000000274089","href":"Leads/{ENTITYID}/Accounts15","type":"multiselectlookup","connectedmodule":"Accounts","linkingmodule":"LinkingModule5"},{"sequence_number":"13","display_label":"Visits - Zoho","api_name":"Visits_Zoho_Livedesk","module":"Visits","name":"Visits - Zoho Livedesk","action":null,"id":"4150868000000493100","href":"Leads/{ENTITYID}/Visits_Zoho_Livedesk","type":"default"},{"sequence_number":"16","display_label":"Related List Name 8","api_name":"Related_List_Name_8","module":"Contacts","name":"Related List Name 8","action":null,"id":"4150868000003813005","href":"Leads/{ENTITYID}/Related_List_Name_8","type":"custom_lookup"}]}