Leads

GET {{api-domain}}/crm/v2/settings/modules/Leads

To get the metadata of the Leads Module.

RESPONSES

status: OK

{"modules":[{"global_search_supported":true,"kanban_view":false,"deletable":true,"description":null,"creatable":true,"filter_status":true,"inventory_template_supported":false,"modified_time":"2021-05-06T06:41:05+00:00","plural_label":"Leads","presence_sub_menu":true,"triggers_supported":true,"id":"738964000000000125","isBlueprintSupported":true,"related_list_properties":{"sort_by":null,"fields":["Full_Name","Company","Email","Lead_Source","Lead_Status","Phone"],"sort_order":null},"per_page":10,"$properties":["$converted","$approved","$approval_state","$state","$converted_detail","$currency_symbol","$review","$review_process","$approval","$in_merge","$process_flow","$orchestration","$stop_processing","$data_source_details"],"visibility":1,"convertable":true,"editable":true,"emailTemplate_support":true,"profiles":[{"name":"Administrator","id":"738964000000015972"},{"name":"Standard","id":"738964000000015975"},{"name":"Sample","id":"738964000001348001"}],"filter_supported":true,"display_field":"Full_Name","search_layout_fields":["Owner","Company","Email","Full_Name","Phone","Lead_Source"],"kanban_view_supported":true,"show_as_tab":true,"web_link":null,"sequence_number":2,"singular_label":"Lead","viewable":true,"api_supported":true,"api_name":"Leads","quick_create":true,"modified_by":{"name":"Patricia Boyle","id":"738964000000291009"},"generated_type":"default","feeds_required":false,"scoring_supported":true,"webform_supported":true,"arguments":[],"module_name":"Leads","business_card_field_limit":5,"custom_view":{"display_value":"My Leads","shared_type":"all","criteria":{"group_operator":"and","group":[{"comparator":"equal","field":"Owner","value":"${CURRENTUSER}"},{"comparator":"equal","field":"$converted","value":false}]},"system_name":"MYVIEWS","shared_details":null,"sort_by":null,"offline":true,"default":true,"system_defined":true,"name":"My Leads","id":"738964000000091563","category":"shared_with_me","fields":["Full_Name","Company","Email","Phone","Lead_Source"],"favorite":null,"sort_order":null},"parent_module":{}}]}