Zoho CRM
12 min
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 url api token url client id client secret redirect uri code (authorization code) capabilities this connector provides the following capabilities get records api documentation link for generating the authorization code, please refer authorization code generation https //www zoho com/crm/developer/docs/api/v5/auth request htmlzoho crm api documentation link https //www zoho com/crm/developer/docs/api/v5/get records html 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 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 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 ids string optional to retrieve specific records based on their unique id 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 per page number optional to get the list of records available per page the default and the maximum possible value is 200 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 sort order string optional to sort the available list of records in either ascending or descending order 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 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 territory id number optional to get the list of records based on the territory 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 output parameter type description status code number http status code of the response reason string response reason phrase data array response data converted date time string time value email object output field email last name string name of the resource id string unique identifier converted s boolean output field converted s info object output field info call boolean output field call per page number output field per page next page token string output field next page token count number count value sort by string output field sort by page number output field page previous page token object output field previous page token page token expiry string output field page token expiry sort order string output field sort order email boolean output field email more records boolean output field more records 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" \[], "info" {} } } ] 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 notes for more information on zoho crm is found at zoho crm main site https //www zoho com/en in/crm/