How to retrieve dashboards in Zoho

Retrieving dashboards in Zoho CRM is straightforward once your API connection is authenticated — a single GET request to the settings endpoint returns all available dashboard data.

Why this matters

If you're building integrations, automating reporting workflows, or auditing your Zoho CRM analytics setup, you'll need programmatic access to your dashboards. This is particularly useful when you want to inventory existing dashboards, sync them with external BI tools, or verify which analytics views are configured for your organisation.

Step-by-step

Step 1. Ensure your Zoho CRM API connection is active and authenticated. The system uses OAuth tokens that may expire, so confirm your accesstoken is valid before making any calls. If the token has lapsed, a refresh flow using your stored refreshtoken will obtain a new one automatically. ^[3]

Step 2. Make a GET request to the /settings/dashboards endpoint on the Zoho CRM API. This is the designated operation — labelled get_dashboards — that sits under the Signals & Analytics category of the CRM settings API. ^[6]

GET /settings/dashboards

Step 3. The underlying Python call that powers this operation is straightforward:

def get_dashboards(self):
    return self.c.request("GET", "/settings/dashboards")

Your client object (self.c) handles attaching the authorisation header and routing the request to the correct data-centre domain. ^[6]

Step 4. Confirm your OAuth scopes include the necessary CRM settings permissions. The required scope group covers ZohoCRM.org.ALL, which grants access to organisation-level settings including analytics configuration. Without the correct scopes granted at the time of OAuth authorisation, the endpoint will return an authorisation error. ^[8]

Step 5. Once you receive a response, parse the returned payload. If you are building links or references back into the Zoho CRM UI, the base URL pattern follows the format https://crm.zoho.{dc}/crm where {dc} is your data-centre suffix (e.g., com, eu, in). ^[5]

Common pitfalls

• Expired or missing access token. If the API connection is not authenticated, the call will fail immediately. Always verify the session is live before executing the request — an unauthenticated state requires re-initiating the OAuth flow. ^[3]
• Wrong data-centre domain. Zoho CRM is hosted across multiple regional data centres. Sending the request to crm.zoho.com when your account is on crm.zoho.eu, for example, will result in a failed or misdirected call. Pull the dc value from your stored connection record and construct the base URL accordingly. ^[5]
• Insufficient OAuth scopes. If the scopes were not configured to include CRM organisation-level access when the OAuth connection was first authorised, the dashboards endpoint will reject the request. You would need to re-authorise the connection with the correct scope set. ^[8]

What to check

• Confirm the API response contains a list of dashboard objects and is not returning an authentication or permission error.
• Verify the dc value in your connection record matches the actual Zoho data centre your account is registered on, so all subsequent URL construction is correct. ^[5]
• Check that the OAuth scopes granted at connection time include ZohoCRM.org.ALL to ensure settings-level endpoints remain accessible. ^[8]

---

*Beam Help provides independent expert support for Zoho — we are not official Zoho support. For platform-level billing or account issues, contact Zoho directly.*