Custom

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

To get the metadata of the custom module.

Request Params

KeyDatatypeRequiredDescription
modulestring

RESPONSES

status: OK

{"related_lists":[{"sequence_number":"1","display_label":"Notes","api_name":"Notes","module":"Notes","name":"Notes","action":null,"id":"738964000000002730","href":"Leads/{ENTITYID}/Notes","type":"default"},{"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":"738964000001920298","href":"Leads/{ENTITYID}/Lead_Status_History","type":"default"},{"sequence_number":"2","display_label":"Attachments","api_name":"Attachments","module":"Attachments","name":"Attachments","action":null,"id":"738964000000002724","href":"Leads/{ENTITYID}/Attachments","type":"default"},{"sequence_number":"3","display_label":"Products","api_name":"Products","module":"Products","name":"Products","action":null,"id":"738964000000002726","href":"Leads/{ENTITYID}/Products","type":"default"},{"sequence_number":"4","display_label":"Open Activities","api_name":"Activities","module":"Activities","name":"Activities","action":null,"id":"738964000000002722","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":"738964000000002720","href":"Leads/{ENTITYID}/Activities_History","type":"default"},{"sequence_number":"6","display_label":"Invited Meetings","api_name":"Invited_Events","module":"Events","name":"Invited Events","action":null,"id":"738964000000044001","href":"Leads/{ENTITYID}/Invited_Events","type":"default"},{"sequence_number":"7","display_label":"Emails","api_name":"Emails","module":"Emails","name":"Emails","action":null,"id":"738964000000002728","href":null,"type":"default"},{"sequence_number":"8","display_label":"Campaigns","api_name":"Campaigns","module":"Campaigns","name":"Campaigns","action":null,"id":"738964000000023017","href":"Leads/{ENTITYID}/Campaigns","type":"default"},{"sequence_number":"9","display_label":"Social","api_name":"Social","module":"Social","name":"Social","action":null,"id":"738964000000048003","href":null,"type":"default"},{"sequence_number":"10","display_label":"Checklists","api_name":"CheckLists","module":"CheckLists","name":"CheckLists","action":null,"id":"738964000000156005","href":"Leads/{ENTITYID}/CheckLists","type":"default"},{"sequence_number":"12","display_label":"Deals","api_name":"Deals8","module":"Deals_X_Leads","name":"Deals","action":null,"id":"738964000001921504","href":"Leads/{ENTITYID}/Deals8","type":"multiselectlookup","connectedmodule":"Potentials","linkingmodule":"LinkingModule8"}]}