How to retrieve scoring rules in Zoho

Retrieving scoring rules in Zoho CRM is straightforward once you know the correct API endpoint and the module parameter it requires.

Why this matters

Scoring rules in Zoho CRM let you automatically rank leads, contacts, deals, and other records based on criteria you define. If you're building integrations, auditing your CRM configuration, or syncing scoring logic to an external system, you'll need a reliable way to pull these rules programmatically. Understanding the exact endpoint and its parameters saves time and prevents misconfigured API calls.

Step-by-step

Step 1. Ensure your OAuth connection includes the necessary Zoho CRM scopes before making any API call. The required scope group for organisation-level settings is ZohoCRM.org.ALL, which covers reading CRM configuration data such as scoring rules. ^[3]

Step 2. Authenticate your client and obtain a valid access token. The token is retrieved by exchanging an authorisation code or refreshing an existing token via Zoho's OAuth token endpoint. Once obtained, the access token is passed as a Bearer token in the Authorization header of every subsequent request. ^[7]

Step 3. Call the scoring rules endpoint using an HTTP GET request:

GET /settings/scoring_rules

This endpoint is categorised under scoring and assignment settings in Zoho CRM. ^[1]

Step 4. Pass the module parameter to specify which CRM module's scoring rules you want to retrieve. For example, to fetch scoring rules for the Leads module, supply module=Leads as a query parameter. The parameter is required — omitting it will not return meaningful results. ^[1]

Step 5. If you are working in Python, the call can be wrapped as shown below. The method accepts the module name as a string (m) and issues the GET request with {"module": m} as the query parameters:

def get_scoring_rules(self, m: str):
    return self.c.request("GET", "/settings/scoring_rules", {"module": m})

This pattern keeps the module name flexible so you can loop over multiple modules (e.g., Leads, Contacts, Deals) without duplicating code. ^[1]

Step 6. Parse the response. The API will return the scoring rules configured for the specified module. Store or process these as needed — for example, logging them for an audit trail or comparing them against a baseline configuration.

Common pitfalls

• Missing or incorrect scope. If your OAuth token was generated without ZohoCRM.org.ALL, the API will return an authorisation error. Always verify the scopes included in your token before debugging the endpoint itself. ^[3]
• Omitting the module parameter. The endpoint expects a module value. Calling GET /settings/scoring_rules without specifying a module may return an empty or error response. Always pass a valid CRM module name such as Leads, Contacts, or Deals. ^[1]
• Expired access tokens. Zoho access tokens expire (typically after 3600 seconds). Your integration should detect expiry and use the refresh token flow to obtain a new access token before retrying the request. ^[5]
• Data centre mismatch. Zoho operates across multiple data centres (.com, .eu, .in, etc.). Make sure your API base URL matches the data centre where your CRM organisation is hosted, otherwise requests will fail or return unexpected results. ^[5]

What to check

• Scope coverage: Confirm that ZohoCRM.org.ALL is present in the scopes used when generating your OAuth token. ^[3]
• Module name accuracy: Verify that the module name you pass matches the exact API name used in your Zoho CRM instance (e.g., Leads not Lead). ^[1]
• Token validity: Check that your access token has not expired before making the call, and that your refresh logic is working correctly. ^[5]

---

*Beam Help is an independent expert support resource for Zoho — we are not official Zoho support. For platform-level issues, always cross-reference with Zoho's official documentation.*