Reference

Endpoint Search [Dynamic Endpoint]

Name

search_[dynamic_endpoint_name]

Description

Search records by criteria or email or phone or word or id (specify only one parameter for search and keep other blank) [API reference]

Related Tables

[Dynamic Table]

Parameters

Parameter Required Options
Name: criteria

Label: Search By Criteria Expression

You can supply upto 10 criterias. For more complex expression use Query API. Example: ((Last_Name:equals:Burns)and(First_Name:starts_with:Ma)). You can lookup row by ID like (id:equals:1458554000067017001). Here is Syntax for expression (({api_name}:{starts_with|equals|in|between|not_equal|greater_equal|less_equal}:{value})and/or({api_name}:{starts_with|equals|in|between|not_equal|greater_equal|less_equal}:{value}))
Option Value
None
Example of Equal (id:equal:11223344)
Example NOT EQUAL (id:not_equal:11223344)
Example OR (multiple conditions) (id:equal:1111111)or(id:equal:222222222)
Example IN (id:in:1111111,222222222,333333333)
Example START_WITH (Last_Name:starts_with:pat)
Example BETWEEN (Created_Time:between:2024-02-01T18:52:56+00:00,2024-02-20T18:52:56+00:00)
Name: email

Label: Search By Email
Name: phone

Label: Search By Phone
Name: word

Label: Search By any Word
Name: id

Label: Search By Id
Name: converted

Label: Include only converted records
Option Value
true true
false false
both both
Name: approved

Label: Include approved records
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

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
Search By Criteria Expression
Search By Email
Search By Phone
Search By any Word
Search By Id
Include only converted records
Include approved records both
SSIS API Source - Read from table or endpoint

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 search [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]
Lookup
Optional Parameters
Search By Criteria Expression
Search By Email
Search By Phone
Search By any Word
Search By Id
Include only converted records
Include approved records both
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Read single row by ID 

SELECT * from Accounts Where Id=1558554000105110008

search_[dynamic_endpoint_name] endpoint belongs to [Dynamic Table] table(s), and can therefore be used via those table(s).

SQL Server

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

Read single row by ID 

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

EXEC (@MyQuery) AT [LS_TO_ZOHO_CRM_IN_GATEWAY];

search_[dynamic_endpoint_name] endpoint belongs to [Dynamic Table] table(s), and can therefore be used via those table(s).