1. CRM Module type query to retrieve data from CRM modules.
   
2. COQL type query to construct a query using the COQL API.
   
3. REST API type query to fetch data from an external service and use it in Zoho CRM.
   

Use case

Step 1 - Add a Source

1. Go to Setup > Developer Hub > Queries > Sources > Add Source.
   
2. Under Information,
   
1. Give a name for the source and its Base URL. Queries will make API calls to this URL to fetch data. Ensure to add this to Trusted Domain.
   
2. Specify any default parameters and headers for this base URL.
   
3. Under Connection, choose the connection you have created with Zoho Desk with the necessary scopes. If you haven't, create one.
   
4. Click Save.
   
   

Note

Queries will make API calls to the URL you add in the Source and consume credits that are applicable in that service. Ensure you monitor your API usage in your source provider.

Step 2 - Create a REST API Query

1. Go to Setup > Developer Hub > Queries > Add Query.
   
2. Under Source, choose the source you created in step 1.
   
3. Under Information,
   
1. Enter the Name, API Name, and the Endpoint of the query.
   
2. Specify the parameter email that takes the dynamic variable {{Contact_Email}} as its value. This is to fetch the latest ticket from Zoho Desk for a contact with the email in this variable during runtime. Refer to our Kaizen post on Handling Query Variables in Zoho CRM for additional details.
   
3. Specify Headers, if any.
   
4. You can serialize the output to fit your needs using JavaScript in the Serializer.
   
   
5. Click Next.
   
6. Enter an email address in the box to test the query.
   
   
7. Click Save. You can see the response of the query and the serialized response if you had serialized the output.
   
   
8. Click Next.
   
9. You can see the Schema of the query. The Schema acts as a bridge/mapping layer between external API responses and Zoho CRM's internal data structure. For example, the response of the Desk API returns result[].assignee.firstName, which is mapped to CRM as Assignee > FirstName. Schema ensures that the CRM UI knows how to display the field correctly.
   With the right mapping in the schema, you can avoid manual data entry or syncing, and use the API data in workflows, reports, and dashboards.
   You can change the CRM Field Type and Label to suit your needs. Refer to our Kaizen post on Serialization and Schema Management for more details.
10. Click Save to save the query.
    

1. On the Canvas, click the database icon for the Queries component.
   
2. Click Associate Query.
   
3. Give an Association Name and select the Source(added in step 1) for the query.
   
4. Under Query, select the query you created.
   
5. The Variables section will contain the variables in the query. The drop-down displays all fields in the Contacts module. Select the Email field.
   
6. Under Result Mapping, choose Email as the Source Record Field and Contact > Email as the Query Response Path. The Query Response Path is populated from the schema of the query.
   
7. Click Done to associate the query with the canvas.
   
   
8. You can see all the fields of the query on the left. Drag and drop the required fields on the canvas.
   
   
9. Save the canvas.
   
   

Note that every time you reload the canvas, the query underneath makes an API call to the source provider to fetch data for the contacts in Zoho CRM. Ensure your API calls are monitored to avoid exhasuting your credits.

See Also

• Queries in Zoho CRM
• Kaizen #166 - Handling Query Variables in Zoho CRM
• Kaizen #169 - Serialization and Schema Management in Queries
• Kaizen #172 - Leveraging the 'crmAPIResponse' object in Queries
• Kaizen Directory
• Previous Kaizen - Mandating Subform Data for Blueprint Transitions using Widget