Get Scoring Rules

GET {{api-domain}}/crm/v3/settings/automation/scoring_rules

To get the list of scoring rules defined for the Organization. For detailed information, refer to our API documentation.

RESPONSES

status: OK

{"scoring_rules":[{"layout":{"api_name":"Standard","id":"4876876000000091055"},"created_time":"2022-04-06T15:19:51+05:30","modified_time":"2022-04-11T10:18:31+05:30","field_rules":[{"score":7,"criteria":{"group_operator":"AND","group":[{"group_operator":"OR","group":[{"comparator":"equal","field":{"api_name":"Company","id":"4876876000000002591"},"value":"Zylker"},{"comparator":"equal","field":{"api_name":"Phone","id":"4876876000000002601"},"value":"123456890"}]},{"comparator":"equal","field":{"api_name":"Designation","id":"4876876000000002597"},"value":"Executive Secretary"}]},"id":"4876876000000945014"},{"score":5,"criteria":{"group_operator":"OR","group":[{"group_operator":"OR","group":[{"comparator":"equal","field":{"api_name":"Company","id":"4876876000000002591"},"value":"Villa Margarita"},{"comparator":"equal","field":{"api_name":"Phone","id":"4876876000000002601"},"value":"5555555555"}]},{"comparator":"equal","field":{"api_name":"Designation","id":"4876876000000002597"},"value":"review"}]},"id":"4876876000000965453"},{"score":5,"criteria":{},"id":"4876876000000965479"}],"module":{"api_name":"Leads","id":"4876876000000002175"},"name":"Rule 1","modified_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"active":true,"description":"Lead Module Scoring Rule","id":"4876876000000945002","signal_rules":[{"score":5,"id":"4876876000000945016","signal":{"namespace":"Email_Incoming__s","id":"4876876000000112019"}},{"score":8,"id":"4876876000000945017","signal":{"namespace":"EmailInsight_Click__s","id":"4876876000000112023"}}],"created_by":{"name":"Patricia Boyle","id":"4876876000000327001"}},{"layout":{"api_name":"Standard","id":"4876876000000091055"},"created_time":"2022-04-11T13:00:01+05:30","modified_time":"2022-05-10T18:20:04+05:30","field_rules":[{"score":10,"criteria":{"group_operator":"AND","group":[{"group_operator":"AND","group":[{"comparator":"equal","field":{"api_name":"Company","id":"4876876000000002591"},"value":"zoho"},{"comparator":"equal","field":{"api_name":"Phone","id":"4876876000000002601"},"value":"123456890"}]},{"comparator":"equal","field":{"api_name":"Designation","id":"4876876000000002597"},"value":"review"}]},"id":"4876876000000965529"}],"module":{"api_name":"Leads","id":"4876876000000002175"},"name":"Rule 2","modified_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"active":false,"description":"Rule for Module Leads","id":"4876876000000965528","signal_rules":null,"created_by":{"name":"Patricia Boyle","id":"4876876000000327001"}},{"layout":{"api_name":"Custom","id":"4876876000000967043"},"created_time":"2022-04-13T15:36:51+05:30","modified_time":null,"field_rules":[{"score":10,"criteria":{"group_operator":"AND","group":[{"group_operator":"AND","group":[{"comparator":"equal","field":{"api_name":"Company","id":"4876876000000002591"},"value":"zoho"},{"comparator":"equal","field":{"api_name":"Mobile","id":"4876876000000002605"},"value":"123456890"}]},{"comparator":"equal","field":{"api_name":"Designation","id":"4876876000000002597"},"value":"review"}]},"id":"4876876000000991042"}],"module":{"api_name":"Leads","id":"4876876000000002175"},"name":"Rule 13","modified_by":null,"active":false,"description":"Rule for Module Leads","id":"4876876000000991041","signal_rules":null,"created_by":{"name":"Patricia Boyle","id":"4876876000000327001"}},{"layout":{"api_name":"Standard","id":"4876876000000091055"},"created_time":"2022-04-13T15:55:13+05:30","modified_time":null,"field_rules":[{"score":7,"criteria":{"group_operator":"AND","group":[{"group_operator":"OR","group":[{"comparator":"equal","field":{"api_name":"Company","id":"4876876000000002591"},"value":"Zylker"},{"comparator":"equal","field":{"api_name":"Phone","id":"4876876000000002601"},"value":"123456890"}]},{"comparator":"equal","field":{"api_name":"Designation","id":"4876876000000002597"},"value":"Executive Secretary"}]},"id":"4876876000000991052"},{"score":5,"criteria":{"group_operator":"OR","group":[{"group_operator":"OR","group":[{"comparator":"equal","field":{"api_name":"Company","id":"4876876000000002591"},"value":"Villa Margarita"},{"comparator":"equal","field":{"api_name":"Phone","id":"4876876000000002601"},"value":"5555555555"}]},{"comparator":"equal","field":{"api_name":"Designation","id":"4876876000000002597"},"value":"review"}]},"id":"4876876000000991056"},{"score":5,"criteria":{},"id":"4876876000000991058"}],"module":{"api_name":"Leads","id":"4876876000000002175"},"name":"Clone of Rule 1","modified_by":null,"active":true,"description":"Lead Module Scoring Rule","id":"4876876000000991051","signal_rules":[{"score":5,"id":"4876876000000991054","signal":{"namespace":"Email_Incoming__s","id":"4876876000000112019"}},{"score":8,"id":"4876876000000991055","signal":{"namespace":"EmailInsight_Click__s","id":"4876876000000112023"}}],"created_by":{"name":"Patricia Boyle","id":"4876876000000327001"}},{"layout":{"api_name":"Standard","id":"4876876000000091055"},"created_time":"2022-05-10T18:10:47+05:30","modified_time":null,"field_rules":[{"score":10,"criteria":{"group_operator":"OR","group":[{"comparator":"equal","field":{"api_name":"Company","id":"4876876000000002591"},"value":"zoho"},{"comparator":"equal","field":{"api_name":"Designation","id":"4876876000000002597"},"value":"review"}]},"id":"4876876000001140003"},{"score":10,"criteria":{"group_operator":"OR","group":[{"comparator":"equal","field":{"api_name":"Company","id":"4876876000000002591"},"value":"Zlabs"},{"comparator":"equal","field":{"api_name":"Designation","id":"4876876000000002597"},"value":"review"}]},"id":"4876876000001140005"}],"module":{"api_name":"Leads","id":"4876876000000002175"},"name":"Rule 3","modified_by":null,"active":false,"description":"Rule for Module Leads","id":"4876876000001140002","signal_rules":null,"created_by":{"name":"Patricia Boyle","id":"4876876000000327001"}}],"info":{"per_page":50,"count":5,"page":1,"more_records":false}}