Leads

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

To get the metadata of the Leads Module.

RESPONSES

status: OK

{"modules":[{"global_search_supported":true,"kanban_view":false,"$field_states":["convert_scheduler"],"deletable":true,"description":null,"creatable":true,"filter_status":true,"inventory_template_supported":false,"modified_time":"2022-05-23T02:34:43+05:30","plural_label":"Leads","presence_sub_menu":true,"triggers_supported":true,"id":"4876876000000002175","isBlueprintSupported":true,"related_list_properties":{"sort_by":null,"fields":["Full_Name","Company","Email","Lead_Source","Lead_Status","Phone"],"sort_order":null},"per_page":20,"$properties":["$converted","$approval_state","$state","$wizard_connection_path","$converted_detail","$currency_symbol","$review","$review_process","$approval","$in_merge","$process_flow","$orchestration","$stop_processing","$data_source_details","$zia_visions","$editable","$field_states"],"visible":true,"visibility":1,"convertable":true,"editable":true,"emailTemplate_support":true,"profiles":[{"name":"Administrator","id":"4876876000000026011"},{"name":"Standard","id":"4876876000000026014"}],"filter_supported":true,"$on_demand_properties":["$blocked_reason","$client_portal_invited"],"display_field":"Full_Name","search_layout_fields":["Owner","Company","Email","Phone","Lead_Source","Full_Name"],"kanban_view_supported":true,"show_as_tab":true,"web_link":null,"sequence_number":2,"singular_label":"Lead","lookup_field_properties":{"fields":[{"sequence_number":1,"api_name":"Full_Name","id":"4876876000000002631"},{"sequence_number":2,"api_name":"Company","id":"4876876000000002591"},{"sequence_number":3,"api_name":"Email","id":"4876876000000002599"},{"sequence_number":4,"api_name":"Phone","id":"4876876000000002601"},{"sequence_number":5,"api_name":"Lead_Source","id":"4876876000000002609"},{"sequence_number":6,"api_name":"Owner","id":"4876876000000002589"}]},"viewable":true,"api_supported":true,"api_name":"Leads","quick_create":true,"modified_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"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":"Untitled View","created_time":"2022-05-12T14:55:40+05:30","access_type":"only_to_me","criteria":null,"system_name":null,"sort_by":null,"created_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"shared_to":null,"default":true,"modified_time":"2022-05-12T14:55:40+05:30","name":"Untitled View","system_defined":false,"modified_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"id":"4876876000001164003","fields":[{"api_name":"First_Name","id":"4876876000000002593"},{"api_name":"Last_Name","id":"4876876000000002595"},{"api_name":"Company","id":"4876876000000002591"},{"api_name":"Email","id":"4876876000000002599"},{"api_name":"Annual_Revenue","id":"4876876000000002617"},{"api_name":"City","id":"4876876000000002637"},{"api_name":"No_of_Employees","id":"4876876000000002615"}],"category":"created_by_me","last_accessed_time":"2022-05-23T09:58:28+05:30","locked":false,"sort_order":null,"favorite":null},"parent_module":{}}]}