Leads

GET {{api-domain}}/crm/v2.1/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-04-04T08:54:55+05:30","plural_label":"Leads","presence_sub_menu":true,"triggers_supported":true,"id":"4150868000000002175","isBlueprintSupported":true,"related_list_properties":{"sort_by":null,"fields":["Full_Name","Company","Email","Lead_Source","Lead_Status","Phone"],"sort_order":null},"per_page":100,"$properties":["$converted","$approved","$approval_state","$state","$converted_detail","$currency_symbol","$review","$review_process","$approval","$in_merge","$followed","$followers","$process_flow","$orchestration","$stop_processing","$data_source_details","$has_more"],"visible":true,"visibility":1,"convertable":true,"editable":true,"emailTemplate_support":true,"profiles":[{"name":"Administrator","id":"4150868000000026011"},{"name":"Standard","id":"4150868000000026014"},{"name":"sample","id":"4150868000001623001"}],"filter_supported":true,"$on_demand_properties":["$blocked_reason"],"display_field":"Full_Name","search_layout_fields":["Owner","Company","Full_Name","Email","Phone","Lead_Source"],"kanban_view_supported":true,"show_as_tab":true,"web_link":null,"sequence_number":23,"singular_label":"Lead","viewable":true,"api_supported":true,"api_name":"Leads","quick_create":true,"modified_by":{"name":"Patricia Boyle","id":"4150868000000225013"},"generated_type":"default","feeds_required":true,"scoring_supported":true,"webform_supported":true,"arguments":[],"module_name":"Leads","business_card_field_limit":5,"custom_view":{"display_value":"Sample View","access_type":"shared","criteria":null,"system_name":null,"sort_by":null,"created_by":{"name":"Patricia Boyle","id":"4150868000000225013"},"shared_to":[{"name":"Group1","id":"4150868000000231952","type":"groups","subordinates":null},{"name":"User 3","id":"4150868000001199001","type":"users","subordinates":null},{"name":"User 2","id":"4150868000001248015","type":"users","subordinates":null}],"default":true,"modified_time":"2021-03-04T00:54:53+05:30","name":"Sample View","system_defined":false,"modified_by":{"name":"Patricia Boyle","id":"4150868000000225013"},"id":"4150868000004520004","fields":[{"api_name":"Full_Name","id":"4150868000000002631"},{"api_name":"Company","id":"4150868000000002591"},{"api_name":"Email","id":"4150868000000002599"},{"api_name":"Phone","id":"4150868000000002601"},{"api_name":"Lead_Source","id":"4150868000000002609"},{"api_name":"Owner","id":"4150868000000002589"}],"category":"created_by_me","last_accessed_time":"2021-05-04T17:11:45+05:30","sort_order":null,"favorite":null},"parent_module":{}}]}