Zoho Crm

This Connector integrates Zoho CRM's REST API with Swimlane Turbine.

Asset Setup

The Connector can be authenticated in one of the following two ways:

Bearer token authentication, which requires an URL and an API token.

Oauth 2.0 client credentials flow, which requires the following inputs :

API Token URL

Client ID

Client Secret

Redirect URI

Code (Authorization Code)

Capabilities

This Connector provides the following capabilities:

Get Records

Notes

For more information on Zoho CRM is found at: Zoho CRM Main Site

API Documentation Link

For generating the Authorization Code, please refer Authorization Code Generation

Zoho CRM API Documentation Link

Configurations

HTTP Bearer Authentication

Authenticates using bearer token such as a JWT, etc.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
token	The API key, token, etc.	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Oauth 2.0 Client Credentials

Authenticates using oauth 2.0 client credentials

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
api_token_url	API Token URL	string	Required
token_url		string	Optional
redirect_uri	Redirect URI.	string	Required
client_id	The Client ID Provided in the Developer Portal	string	Required
client_secret	The Client Secret Provided in the Developer Portal	string	Required
code	Grant token.	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Get Records

Retrieve the records that match your search criteria.

Endpoint

URL: /crm/v5/Leads

Method: GET

Input

Argument Name	Type	Required	Description
parameters.fields	string	Required	To list all the module records with respect to fields. Note that you can include a maximum of 50 field API names in this parameter.
parameters.cvid	number	Optional	To get the list of records based on custom views. Note that you cannot use this param with the "sort_by" param.You can get custom view id from Custom View Meta API.
parameters.ids	string	Optional	To retrieve specific records based on their unique ID.
parameters.page	number	Optional	To get the list of records from the respective pages. The default value is 1. Note that you cannot use this param with the "page_token" param.
parameters.per_page	number	Optional	To get the list of records available per page. The default and the maximum possible value is 200.
parameters.page_token	string	Optional	You can use the "page" param to fetch up to 2000 records without "page_token". To fetch more than 2000 records, you must include the "page_token" param in the request. This param takes the value from the key "next_page_token" in the response of the first Get Records call. Note that this token value is user-specific. If you use another user's token, the system throws an error. Note that you cannot use this param with the "page" param.
parameters.sort_order	string	Optional	To sort the available list of records in either ascending or descending order.
parameters.sort_by	string	Optional	To sort the records based on the fields id, Created_Time, and Modified_Time. The default value is 'id'. Note that you cannot use this param with the "cvid" param.
parameters.converted	string	Optional	To get the list of converted records. Default value is false. Possible values are as follows 1. true - get only converted records, 2. false - get only non-converted records, both - get all records.
parameters.territory_id	number	Optional	To get the list of records based on the territory.
parameters.include_child	boolean	Optional	To include records from the child territories.Default value is false. Possible values are 1. true - includes child territory records, 2. false - does not include child territory records.

Input Example

{"parameters":{"fields":"Last_Name,Email,Converted__s,Converted_Date_Time","cvid":12345678,"ids":"4150868000001944196","page":1,"per_page":5,"page_token":"c8582xx9e7c7","sort_order":"desc","sort_by":"id","converted":"false","territory_id":1234567890,"include_child":false}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.Converted_Date_Time	string	Response data
data.Email	object	Response data
data.Last_Name	string	Response data
data.id	string	Response data
data.Converted__s	boolean	Response data
info	object	Output field: info
info.call	boolean	Output field: info.call
info.per_page	number	Output field: info.per_page
info.next_page_token	string	Output field: info.next_page_token
info.count	number	Count value
info.sort_by	string	Output field: info.sort_by
info.page	number	Output field: info.page
info.previous_page_token	object	Output field: info.previous_page_token
info.page_token_expiry	string	Output field: info.page_token_expiry
info.sort_order	string	Output field: info.sort_order
info.email	boolean	Output field: info.email
info.more_records	boolean	Output field: info.more_records

Output Example

{"status_code":200,"response_headers":{"content-length":"140","Accept":"application/json","content-type":"application/json","Date":"Wed, 13 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{"Converted_Date_Time":"2022-11-21T15:12:13+05:30","Email":null,"Last_Name":"test8000","id":"3652397000009851001","Converted__s":true},{"Converted_Date_Time":"2022-11-21T15:12:13+05:30","Email":null,"Last_Name":"test7000","id":"3652397000009850001","Converted__s":true},{"Converted_Date_Time":"2022-11...

Response Headers

Header	Description	Example
Accept	HTTP response header: Accept	application/json
content-length	The length of the response body in bytes	140
content-type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Wed, 13 Dec 2023 20:37:23 GMT