Beam Help
Get help now

How-to · Zoho CRM

How to retrieve related records in Zoho CRM

Fetch records related to a parent record through relationships.

Zoho CRM offers several ways to retrieve related records — from a no-code UI component that mirrors live data directly on a record's detail page, to developer-facing GraphQL and REST-based query tools for programmatic access.


Why this matters


When working in Zoho CRM, records rarely exist in isolation. A deal links to a contact; a case ties to an account. Without a structured way to surface that related data, your team wastes time navigating between modules to find a phone number, email address, or status update. Knowing which retrieval method fits your use case — UI-based or API-based — saves significant time and reduces context-switching.


Step-by-step


Option A: Use the Mirror Component (No-code, UI)


Step 1. Understand what the Mirror Component does. It acts as a live window embedded directly on a record's detail page, reflecting field values from a related record in real time. For example, a sales rep working on a deal can see the linked contact's phone number or email address without ever leaving the deal record. [1]


Step 2. Check your data centre eligibility. As of the latest release, the Mirror Component is available for the JP, CA, SA, UAE, and AU data centres. If your organisation is on one of these DCs, the feature should be accessible from your CRM settings. [1]


Step 3. Navigate to the record detail page where you want to add the component. The Mirror Component is configured at the page layout level — open Setup → Modules and Fields, select the relevant module, and open the layout editor for that module's detail view. [1]


Step 4. Locate the Mirror Component option in the layout editor's component palette and drag it onto the layout canvas. Configure it by selecting the lookup field that defines the relationship (for example, the Contact lookup on a Deal), then choose which fields from the related record you want to display. [1]


Step 5. Save the layout. Team members viewing that record will now see the mirrored fields updated in real time — no navigation required. [1]


---


Option B: Use the GraphQL API (Developer, read-heavy queries)


Step 1. Confirm your CRM edition supports GraphQL. The GraphQL API is not available on trial versions of any Zoho CRM edition — you need a paid plan. [3]


Step 2. Authenticate your API client using a valid OAuth 2.0 token for Zoho CRM. Once authenticated, you can query both record data and metadata through the root Query type, which exposes two top-level fields: Records and Meta. [3]


Step 3. Build a query that fetches fields from multiple related modules in a single request. For instance, to retrieve account names alongside lead last names in one call, structure your query like this: [3]


query {
  Records {
    Accounts {
      _data {
        Account_Name {
          value
        }
      }
    }
    Leads {
      _data {
        Last_Name {
          value
        }
      }
    }
  }
}

Step 4. Use the Meta type when you need structural information — such as role api_name values or user details — rather than record data. Both Meta and Records support filtering and pagination to narrow large result sets. [3]


---


Option C: Use the Queries Feature (Developer, external/database sources)


Step 1. Navigate to Setup → Developer Space → Queries in Zoho CRM. This feature lets you define data sources and write SQL-style queries against them. [5]


Step 2. Add a source. Supported source types include:

  • REST API — point to an external endpoint with a base URL, default parameters, and headers. [5]
  • Database — connect MySQL, Microsoft SQL, or PostgreSQL by supplying the host, port, database name, credentials, and optional SSL settings. [5]
  • Cloud Database — connect Amazon RDS, Google Cloud Platform, or Microsoft Azure databases with similar configuration fields. [5]

Step 3. If your source host is not in IP address format, add it to Trusted Domains in CRM settings. Additionally, whitelist Zoho CRM's IP addresses on your relay server so CRM can reach your database. [5]


Step 4. Write and save your query. Refer to the Limits page within the Queries documentation for SQL query source limits, query restrictions, and sample structures for different operations. [5]


---


Common pitfalls


  • Mirror Component not visible? Double-check your data centre. The feature is currently limited to JP, CA, SA, UAE, and AU DCs — organisations on other DCs will not see it in the layout editor yet. [1]
  • GraphQL returning nothing on a trial account? The GraphQL API is explicitly unavailable on trial editions. Upgrade to a paid plan before attempting API calls. [3]
  • Database queries failing? The two most common causes are a missing Trusted Domains entry for your host and Zoho CRM IPs not being whitelisted on your relay server. Resolve both before testing connectivity. [5]

---


What to check


  • Mirror Component: After saving the layout, open a live record and confirm the mirrored fields display current values from the related record — not stale or blank data. [1]
  • GraphQL: Verify your query returns the expected value fields under _data for each module, and that pagination parameters are working if your dataset is large. [3]
  • Queries / Database sources: Confirm the source connection status shows as active in the Queries setup page, and run a test query to validate row retrieval before embedding it in automation. [5]

---


*Beam Help is an independent expert support resource for Zoho products and is not official Zoho support. For platform-level issues or billing questions, contact Zoho directly through your account portal.*

Sources cited

  1. [1] Mirror Component in Zoho CRM: Access real-time related data without leaving your record
  2. [2] server.py: build_zoho_links
  3. [3] GraphQL - An overview
  4. [4] Zoho Community | Connect, network, and share on Zoho Forums
  5. [5] Hi, how can we help?
  6. [6] Associate Google Event with Zoho CRM Contact
  7. [7] Zoho FSM | Integrating Zoho FSM with Zoho Desk
  8. [8] run_api_tests.py