Beam Help
Get help now

How-to · Zoho CRM

How to retrieve record sections in Zoho CRM

Get layout sections and fields for a record.

Retrieving record sections in Zoho CRM can be accomplished through the UI using the Mirror Component for real-time related-record data, or programmatically via the GraphQL API to query specific fields across modules. This guide covers both approaches so you can choose the right method for your use case.


---


*Beam Help is independent expert support for Zoho — not official Zoho support.*


---


Why this matters


When working in Zoho CRM, records rarely exist in isolation — a deal links to a contact, a case ties to a customer, and each related record holds critical context. [1] Without a structured way to surface that data, teams waste time navigating between modules to find the latest phone number, email address, or account status. [1] Whether you need a no-code visual solution or a developer-grade API query, knowing how to retrieve record sections efficiently keeps your team focused and your data accurate.


---


Step-by-step


Option A — Using the Mirror Component (UI, no code required)


Step 1. Understand what the Mirror Component does. It acts as a live window into a related record, displaying fields from that linked record directly on the details page of the record you are currently viewing — no module-switching required. [1]


Step 2. Confirm your Data Centre eligibility. As of the latest announcement, the Mirror Component is available for the JP, CA, SA, UAE, and AU data centres. [1] If your organisation is on a different DC, check the Zoho CRM release notes for availability updates. [7]


Step 3. Navigate to the record detail page where you want to surface related data — for example, a Deals record that is linked to a Contact. [1]


Step 4. Open the page layout editor for that module (via Setup → Modules and Fields → [Module] → Layouts) and add the Mirror Component to the layout. Configure it to point at the related module (e.g., Contacts) and select the specific fields you want reflected, such as phone number or email address. [1]


Step 5. Save the layout and return to a live record. The mirrored fields will now display real-time values pulled directly from the linked record, so your team always sees the most current data without leaving the page. [1]


---


Option B — Using the GraphQL API (developer/programmatic retrieval)


Step 1. Verify API access. Zoho CRM's GraphQL APIs are not available in trial editions of any CRM plan, so ensure your organisation is on a paid edition before proceeding. [2]


Step 2. Understand the two root query types available. The Meta type lets you retrieve metadata from sources such as Modules, Users, Roles, Profiles, and Widgets. The Records type lets you retrieve actual field data from any module your profile can access, with filtering and pagination supported across all modules. [2]


Step 3. Construct your GraphQL query. To retrieve record sections (fields) from multiple modules in a single request, nest the desired modules under Records and specify the field names inside data. For example, to pull AccountName from Accounts and Last_Name from Leads simultaneously, your query would look like this: [2]


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

Step 4. Send the query to the Zoho CRM GraphQL endpoint using your preferred HTTP client or the JavaScript SDK. The SDK provides sample code for fetching records from modules such as Leads, and supports multiple API versions (V6, V7, V8). [3]


Step 5. Parse the response. Each module's records are returned under their respective _data arrays, with each field exposing a value property. [2] Map these values to your application's data model as needed.


---


Common pitfalls


  • Trial edition block: Attempting to use the GraphQL API on a trial account will fail outright — the API is explicitly unavailable in trial versions. [2] Upgrade to a paid edition first.
  • Mirror Component DC restriction: If your organisation's data centre is not among JP, CA, SA, UAE, or AU, the Mirror Component may not yet be available. [1] Check the release notes page for your DC's rollout status. [7]
  • Lookup fields vs. Mirror Component: Standard lookup fields establish relationships between modules but cannot surface all contextual field data within the parent record. [1] Do not confuse a lookup field with the Mirror Component — they serve different purposes.
  • Mobile visibility gaps: Related list fields and components configured on the web layout may not automatically appear on the CRM mobile app. [4] Test your layout on mobile after making changes.

---


What to check


  • Mirror Component: After saving the layout, open a live record and confirm the mirrored fields display current values from the linked record — not stale or empty data. [1]
  • GraphQL query: Verify that the field API names used in your query (e.g., AccountName, LastName) exactly match the API names defined in your CRM module configuration, as mismatches will return null values. [2]
  • Edition and DC: Confirm both your CRM edition (paid, not trial) and your data centre are supported for whichever retrieval method you have chosen. [1][2]

Sources cited

  1. [1] Mirror Component in Zoho CRM: Access real-time related data without leaving your record
  2. [2] GraphQL - An overview
  3. [3] Hi, how can we help?
  4. [4] Zoho Community | Connect, network, and share on Zoho Forums
  5. [5] Zoho Community | Connect, network, and share on Zoho Forums
  6. [6] Extracting record counts for Zoho Creator C6 application Using Zoho RPA
  7. [7] What's New in Zoho CRM
  8. [8] What's New in Zoho CRM
Retrieve Record Sections | Beam Help