Reference

Endpoint Read [Dynamic Endpoint] (Use this for fewer than 50 Fields in v3+)

Name

get_[dynamic_endpoint_name]_fast

Description

Use this endpoint if you have fewer than 50 fields and you like to utilize newer APi e.g. V3+, If you calling older API V2 then you can use any endpoint (e.g. get_contacts or get_contacts_fast or Contacts table all yeilds same speed in V2). [API reference]

Parameters

Parameter Required Options
Name: Module

Label: Module
Name: If-Modified-Since

Label: Fetch records modified after (local time format: yyyy-MM-ddTHH:mm:ss)

Supply this DateTime (Local Time in ISO 8601 format) - To get the list of recently modified records after this datetime.
Name: cvid

Label: Custom View ID

To get the list of records based on custom views.
Name: fields

Label: Fields (Only for V2 API)

To retrieve specific field values. Kepp blank to get all fields.
Name: sort_by

Label: sort_by

Specify the field name based on which the records must be sorted.
Name: sort_order

Label: sort_order

To sort the list of records in either ascending or descending order.
Option Value
asc asc
desc desc
Name: territory_id

Label: territory_id

To get the list of records in a territory. Use get_territories endpoint to list Id and names.
Name: include_child

Label: include_child

To include records from the child territories. Default is false.
Option Value
true true
false false
Name: converted

Label: converted

converted
Option Value
true true
false false
both both
Name: approved

Label: Return Approved Records

To get the list of approved records. Default value is true.
Option Value
true true
false false
both both
Name: PageSize

Label: PageSize
Option Value
200 200
100 100
50 50
10 10

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(25) 25
-Dynamic- DT_WSTR nvarchar(4000) 4000
[$parent.api_name$] DT_WSTR nvarchar(4000) 4000
[$parent.api_name$]_Id DT_WSTR nvarchar(4000) 4000
Created_By_Id DT_WSTR nvarchar(25) 25
Created_By_Email DT_WSTR nvarchar(255) 255
Created_By_Name DT_WSTR nvarchar(255) 255
Modified_By_Id DT_WSTR nvarchar(25) 25
Modified_By_Email DT_WSTR nvarchar(255) 255
Modified_By_Name DT_WSTR nvarchar(255) 255
Owner_Id DT_WSTR nvarchar(25) 25
Owner_Email DT_WSTR nvarchar(255) 255
Owner_Name DT_WSTR nvarchar(255) 255
$approval_state DT_WSTR nvarchar(20) 20
$approved DT_BOOL bit
$state DT_WSTR nvarchar(50) 50
If the column you are looking for is missing, consider customizing Zoho CRM Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Zoho CRM Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Zoho CRM
Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.
Zoho CRM
Read [Dynamic Endpoint] (Use this for fewer than 50 Fields in v3+)
Optional Parameters
Module [$parent.api_name$]
Fetch records modified after (local time format: yyyy-MM-ddTHH:mm:ss) 1900-12-31T00:00:00
Custom View ID
FieldsMultiSelectAllOnBlank False
FieldsMultiSelectLimit 0
Fields (Only for V2 API)
sort_by
sort_order
territory_id
include_child
converted
PagingMode ByUrlParameter
NextUrlAttributeOrExpr $.info.next_page_token
NextUrlSuffix page_token=<%nextlink%>
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Zoho CRM
Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.
Zoho CRM
Read [Dynamic Endpoint] (Use this for fewer than 50 Fields in v3+)
Optional Parameters
Module [$parent.api_name$]
Fetch records modified after (local time format: yyyy-MM-ddTHH:mm:ss) 1900-12-31T00:00:00
Custom View ID
FieldsMultiSelectAllOnBlank False
FieldsMultiSelectLimit 0
Fields (Only for V2 API)
sort_by
sort_order
territory_id
include_child
converted
PagingMode ByUrlParameter
NextUrlAttributeOrExpr $.info.next_page_token
NextUrlSuffix page_token=<%nextlink%>
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Read [Dynamic Endpoint] 

SELECT * FROM get_[dynamic_endpoint_name]_fast

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Read [Dynamic Endpoint] 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_[dynamic_endpoint_name]_fast';

EXEC (@MyQuery) AT [LS_TO_ZOHO_CRM_IN_GATEWAY];