Custom

GET {{api-domain}}/crm/v3/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":"0","display_label":"Scoring Rules","customize_sort":false,"customize_fields":false,"api_name":"Entity_Scores__s","module":{"api_name":"Entity_Scores__s","id":"4876876000000511009"},"customize_display_label":false,"name":"Scoring Rules","action":null,"id":"4876876000000511039","href":"Leads/{ENTITYID}/Entity_Scores__s","type":"default"},{"sequence_number":"1","display_label":"Notes","customize_sort":true,"customize_fields":true,"api_name":"Notes","module":{"api_name":"Notes","id":"4876876000000002197"},"customize_display_label":false,"name":"Notes","action":null,"id":"4876876000000015122","href":"Leads/{ENTITYID}/Notes","type":"default"},{"sequence_number":"2","display_label":"Attachments","customize_sort":true,"customize_fields":false,"api_name":"Attachments","module":{"api_name":"Attachments","id":"4876876000000002227"},"customize_display_label":false,"name":"Attachments","action":null,"id":"4876876000000003771","href":"Leads/{ENTITYID}/Attachments","type":"default"},{"sequence_number":"3","display_label":"Products","customize_sort":true,"customize_fields":true,"api_name":"Products","module":{"api_name":"Products","id":"4876876000000002213"},"customize_display_label":false,"name":"Products","action":null,"id":"4876876000000003773","href":"Leads/{ENTITYID}/Products","type":"default"},{"sequence_number":"4","display_label":"Open Calls","customize_sort":true,"customize_fields":true,"api_name":"Calls","module":{"api_name":"Calls","id":"4876876000000033015"},"customize_display_label":false,"name":"Calls","action":null,"id":"4876876000000768752","href":"Leads/{ENTITYID}/Calls","type":"default"},{"sequence_number":"4","display_label":"Open Meetings","customize_sort":true,"customize_fields":true,"api_name":"Events","module":{"api_name":"Events","id":"4876876000000002195"},"customize_display_label":false,"name":"Events","action":null,"id":"4876876000000768750","href":"Leads/{ENTITYID}/Events","type":"default"},{"sequence_number":"4","display_label":"Open Tasks","customize_sort":true,"customize_fields":true,"api_name":"Tasks","module":{"api_name":"Tasks","id":"4876876000000002193"},"customize_display_label":false,"name":"Tasks","action":null,"id":"4876876000000768748","href":"Leads/{ENTITYID}/Tasks","type":"default"},{"sequence_number":"5","display_label":"Closed Calls","customize_sort":true,"customize_fields":true,"api_name":"Calls_History","module":{"api_name":"Calls","id":"4876876000000033015"},"customize_display_label":false,"name":"Calls History","action":null,"id":"4876876000000768758","href":"Leads/{ENTITYID}/Calls_History","type":"default"},{"sequence_number":"5","display_label":"Closed Meetings","customize_sort":true,"customize_fields":true,"api_name":"Events_History","module":{"api_name":"Events","id":"4876876000000002195"},"customize_display_label":false,"name":"Events History","action":null,"id":"4876876000000768756","href":"Leads/{ENTITYID}/Events_History","type":"default"},{"sequence_number":"5","display_label":"Closed Tasks","customize_sort":true,"customize_fields":true,"api_name":"Tasks_History","module":{"api_name":"Tasks","id":"4876876000000002193"},"customize_display_label":false,"name":"Tasks History","action":null,"id":"4876876000000768754","href":"Leads/{ENTITYID}/Tasks_History","type":"default"},{"sequence_number":"6","display_label":"Emails","customize_sort":true,"customize_fields":false,"api_name":"Emails","module":{"api_name":"Emails","id":"4876876000000014163"},"customize_display_label":false,"name":"Emails","action":null,"id":"4876876000000014410","href":null,"type":"default"},{"sequence_number":"6","display_label":"Invited Meetings","customize_sort":true,"customize_fields":false,"api_name":"Invited_Events","module":{"api_name":"Events","id":"4876876000000002195"},"customize_display_label":false,"name":"Invited Events","action":null,"id":"4876876000000062001","href":"Leads/{ENTITYID}/Invited_Events","type":"default"},{"sequence_number":"8","display_label":"Campaigns","customize_sort":true,"customize_fields":true,"api_name":"Campaigns","module":{"api_name":"Campaigns","id":"4876876000000002183"},"customize_display_label":false,"name":"Campaigns","action":null,"id":"4876876000000040017","href":"Leads/{ENTITYID}/Campaigns","type":"default"},{"sequence_number":"9","display_label":"Social","customize_sort":true,"customize_fields":false,"api_name":"Social","module":{"api_name":"Social","id":"4876876000000065001"},"customize_display_label":false,"name":"Social","action":null,"id":"4876876000000065003","href":null,"type":"default"},{"sequence_number":"10","display_label":"Checklists","customize_sort":true,"customize_fields":false,"api_name":"CheckLists","module":{"api_name":"CheckLists","id":"4876876000000141001"},"customize_display_label":false,"name":"CheckLists","action":null,"id":"4876876000000141005","href":"Leads/{ENTITYID}/CheckLists","type":"default"}]}