ReadAPI
Specifies which API to use for data operations: the Bulk API, the REST API or the COQL API. The selected API affects how the provider performs read operations when retrieving or modifying data from Zoho CRM.
Possible Values
Bulk, REST, COQLData Type
string
Default Value
"COQL"
Remarks
This property allows you to switch between the Bulk, REST, and COQL APIs for read operations.
- Bulk API: Allows for more efficient data processing when working with significant datasets.
- REST API: Better suited for real-time interactions or working with smaller data volumes. REST API supports more granular operations and is more flexible for transactional tasks.
- COQL API: Query API(COQL) is optimized for flexibility and easy querying, particularly for single-table or single-view queries. It allows you to use SQL-like syntax to retrieve data efficiently.
The following lists the limitations of the Query API(COQL) by Schema.
| v4 | Maximum of 50 columns per query. |
| v8 | Maximum of 200 columns per query. |
For schema v4, if you need to retrieve more columns than these limits allow, consider using other APIs such as the Bulk API, which have different capabilities and limits. Refer to the relevant documentation for your schema (v4, or v8) for details on these limits based on the selected schema version.
Note: This property does not specify the Zoho CRM version whose associated data model is used by the provider. The Zoho CRM version is specified by Schema.