Get Records

Description

Zoho CRM: Get Records step fetches records matching the criteria query.

No.	Scope
1	scope=ZohoCRM.coql.READ (and) scope=ZohoCRM.modules.all OR scope=ZohoCRM.modules.{module_name}.{operation_type}

References: • https://www.zoho.com/crm/developer/docs/api/v3/get-records.html • https://www.zoho.com/crm/developer/docs/api/v3/Get-Records-through-COQL-Query.html

Configurations

General Tab:

No.	Field Name	Description
1	Step Name	Name of the step. This name has to be unique in a single workflow.
	Connection:
2	Base URL	Specify a base URL of the Zoho CRM instance. For example: https://crm.zoho.in The Base URL will change as per the Data Centre.
3	Client Id	Specify the client Id that is created on Zoho Developer Console. The data type is string. This field is mandatory.
	Client Secret:
4	Checkbox: Accept value as variable/static	Leave checkbox unchecked to accept Client Secret from a field in the previous steps using a drop down list, else enable checkbox for Client Secret field to appear as text box.
5	Client Secret	Specify Client Secret that is created on Zoho Developer Console. The data type is string. This field is mandatory.If checkbox above is enabled Client Secret field appears as Text box and you may provide a static value or variable. Else if checkbox above is disabled Client Secret field appears as a drop down containing fields from previous steps. You may select the field containing the Client Secret value.
	Refresh Token:	The process to get Refresh Token is available in Appendix 27: ZOHO CRM: Generate Refresh Token.
5	Checkbox: Accept value as variable/static	Leave checkbox unchecked to accept Refresh Token from a field in the previous steps using a drop down list. Else enable checkbox for Refresh Token field to appear as Text box.
6	Refresh Token	Specify the Refresh Token with appropriate permissions. The data type is string. This field is mandatory. If checkbox above is enabled Refresh Token field appears as Text box and you may provide a static value or variable. Else if checkbox above is disabled Refresh Token field appears as a drop down containing fields from previous steps. You may select the field containing the Refresh Token value.
7	Test Connection	Verifies the connection is established or not. Note: The Test Connection button does not work for previous step variables. The button only works with static values and environment variables.

Input Tab

No.	Field Name	Description
	Input Fields:
1	Module	Specify a module module whose records are to be fetched.The data type is string. This field is mandatory.
2	Get	On click; if connection is successfully established it populates the list of modules. Note: The Get button will not work for the previous step variables; the button will only work with static values and environment variables in the connection parameters.
3	Criteria Query	Provide the Criteria Query to get the records. Example: 1. Select Last_Name from Contacts where Last_Name is not null 2.Select Last_Name, Account_Name.Parent_Account, Account_Name.Parent_Account.Account_Name from Contacts where Last_Name is not null and Account_Name.Parent_Account.Account_Name is not null. The data type is string. This field is mandatory.
4	Fetch Record Batch Size	Specify the batch size based on which the step will fetch the record. Note: A numeric value between 1 to 200 is allowed. The data type is string. This field is mandatory.

Output Tab

No.	Field Name	Description
	Output Fields:
1	Record ID	Specify an output field to define the output variable name. The default output variable name is “RecordID”. On successful execution, it holds the Record ID.
2	Field Name	Click in the output table, and fields associated with the module will be populated.
3	Output Field	Specify an output field to define the output variable name. It holds the value of the respective field name.