Beam Help
Get help now

How-to · Zoho CRM

How to get related lists in Zoho CRM

Retrieve all related records and associated data from a parent record.

Retrieving related lists in Zoho CRM lets you surface linked records — such as contacts, deals, or work orders — directly from a parent record's detail page, and also programmatically via the REST API.


Why this matters


When your team manages complex relationships between modules (for example, Partners → Work Orders → Customers), being able to view and manipulate related lists is essential for avoiding data silos and double entry. [1] Whether you're building a customer portal, automating workflows, or simply navigating records day-to-day, understanding how related lists work in Zoho CRM saves significant time. The Mirror Component feature and multi-select lookup related lists are two of the most powerful — and sometimes misunderstood — tools in this space. [^1,3]


---


Step-by-step


Step 1. Understand the two main approaches.


Zoho CRM gives you two broad ways to work with related lists: through the UI (on a record's detail page) and through the REST API (programmatically). Which path you take depends on whether you need real-time visibility for users or automated data operations for integrations. [1]


Step 2. Use the Mirror Component for real-time related data in the UI.


The Mirror Component is a feature on a record's detail page that presents relevant related data without requiring the user to navigate away. Once enabled, it keeps everything a user needs in a single view. [^1,3] To enable it:


  • Navigate to the module where you want to add the Mirror Component.
  • Open Setup → Customization → Modules and Fields, then select the relevant module.
  • In the layout editor, look for the Mirror Component option and add it to the detail page layout.
  • Configure which related module's data should be mirrored — for example, surfacing Work Order details on a Partner record. [1]

> Note (as of writing): The Mirror Component is available across multiple data centres including JP, CA, SA, UAE, and AU DCs. [^1,3]


Step 3. Set up lookup fields to define the relationship.


Before a related list appears, the modules must be linked via a Lookup field or a Multi-select Lookup field. For example, to link Partners → Work Orders → Customers, you would create lookup fields on the Work Order module pointing to both the Partner and Customer modules. [1] To do this:


  • Go to Setup → Customization → Modules and Fields.
  • Select the child module (e.g., Work Orders).
  • Add a Lookup field and point it to the parent module (e.g., Partners).
  • Save and deploy the layout. The related list will now appear automatically on the parent record's detail page. [1]

Step 4. Retrieve related list records via the REST API.


If you need to pull related list data programmatically, Zoho CRM's REST API supports this. For a standard lookup relationship, you can use the Get Related Records endpoint, structured around the module and the parent record ID. The CRM URL pattern for a record follows the format https://crm.zoho.{dc}/crm/tab/{Module}/{RecordId}, which mirrors how the API organises module and record references. [2]


For Multi-select Lookup related lists specifically, there are two supported methods via the API: [^1,3]


  1. Insert Records API — create and associate records in a single call.
  2. Linking Module — use the intermediary linking module that Zoho CRM automatically generates for multi-select lookups to associate existing records.

Choose the linking module approach when you need to associate records that already exist in both modules without recreating them. [^1,3]


Step 5. Verify data centre configuration for API calls.


When building API requests or direct links to CRM records, make sure your base URL reflects the correct data centre. For the .com DC, the base is https://crm.zoho.com; for others, it follows the pattern https://crm.zoho.{dc}. [2] Mismatched data centres are a common cause of failed API calls.


---


Common pitfalls


  • Missing lookup field: A related list will not appear on a record's detail page unless a lookup field has been properly configured between the two modules. Double-check that the field is added to the active layout. [1]
  • Multi-select lookup confusion: Many users attempt to associate multi-select lookup records using only the Insert Records API, but the linking module method is often required for associating pre-existing records. Both methods are valid but serve different use cases. [^1,3]
  • Wrong data centre in API URLs: If your organisation is on a non-.com data centre (e.g., AU, EU, IN), hardcoding crm.zoho.com in API calls or portal links will cause failures. Always parameterise the DC. [2]
  • Mirror Component availability: If you cannot find the Mirror Component in your layout editor, confirm your organisation's data centre is among the supported ones before raising a support ticket. [^1,3]

---


What to check


  • Lookup field is present and deployed on the child module's layout, and the resulting related list is visible on the parent record's detail page.
  • API endpoint and data centre match your organisation's CRM region (check under Setup → Company Details if unsure). [2]
  • Multi-select lookup linking module exists in your module list if you are using the API to associate records for an MxN relationship. [^1,3]

---


*Beam Help is an independent expert support resource for Zoho products — we are not official Zoho support. For billing or account-level issues, please contact Zoho directly.*

Sources cited

  1. [1] Zoho Community | Connect, network, and share on Zoho Forums
  2. [2] server.py: build_zoho_links
  3. [3] [Heads Up] Upcoming update to field values in Zoho Books - Zoho Analytics integration
Get Related Lists in Zoho CRM | Beam Help