Endpoint Read [Dynamic Endpoint]

Name

get_[dynamic_endpoint_name]

Description

This endpoint reads records using bulk approach. Default API Version is V2 (set connection level) and its almost 2 times faster than higher API version (e.g. V3+) but V2 may return less number of columns compared to new API versions (e.g. v3...v7+). API V2 makes less number of requests and returns more records per call (200 rows), on the other side V3+ has limits of max 50 fields in each Get Records API calls. To avoid this limitation in V3+ API we used /{module}?ids={150 ids} workaround but this is still slower compred to older API (v2) approach. Choose new API if you have a valid reason (e.g. you need additional new columns exposed in v3+) else stick with older version V2 (its default setting) [API reference]

Related Tables

[Dynamic Table]

Parameters

Output Columns

Input Columns

Examples

SSIS

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

API Source

This Endpoint belongs to the [Dynamic Table] table, therefore it is better to use it, instead of accessing the endpoint directly:

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

[Dynamic Table]

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
DisableChildEndPoint	True
FieldsValue	id
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%>

API Destination

This Endpoint belongs to the [Dynamic Table] table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to read [dynamic endpoint]:

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

[Dynamic Table]

Select

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
DisableChildEndPoint	True
FieldsValue	id
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%>

ODBC application

Use these SQL queries in your ODBC application data source:

Read all rows

SELECT * from Accounts

Read reacord(s) modified after certain date

SELECT * from Accounts WITH(ModifiedSince = '2020-01-07T00:00:00')

Search accounts by specific field (server side filter)

You can use criteria listed here https://www.zoho.com/crm/developer/docs/api/v2/search-records.html

SELECT * FROM search_Accounts WITH(criteria='Account_Name:starts_with:test')

SQL Server

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

Read all rows

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * from Accounts';

EXEC (@MyQuery) AT [LS_TO_ZOHO_CRM_IN_GATEWAY];

Read reacord(s) modified after certain date

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * from Accounts WITH(ModifiedSince = ''2020-01-07T00:00:00'')';

EXEC (@MyQuery) AT [LS_TO_ZOHO_CRM_IN_GATEWAY];

Search accounts by specific field (server side filter)

You can use criteria listed here https://www.zoho.com/crm/developer/docs/api/v2/search-records.html

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM search_Accounts WITH(criteria=''Account_Name:starts_with:test'')';

EXEC (@MyQuery) AT [LS_TO_ZOHO_CRM_IN_GATEWAY];