Endpoint

List Module Settings

Name

get_module_settings

Description

To get the metadata for a specific module. Specify the API name of the module, such as Leads, Accounts or Deals in your API request. [API reference]

Parameters

Parameter

Label

Required

Options

Description

module

YES

Option	Value
Accounts	Accounts
Activities	Activities
Calls	Calls
Campaigns	Campaigns
Cases	Cases
Contacts	Contacts
Deals	Deals
Events	Events
Invoices	Invoices
Leads	Leads
Price_Books	Price_Books
Products	Products
Purchase_Orders	Purchase_Orders
Quotes	Quotes
Sales_Orders	Sales_Orders
Solutions	Solutions
Tasks	Tasks
Vendors	Vendors
Your_Custom_Module_Name	Your_Custom_Module_Name

Module name for which you like to get settings

Output Columns

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

If the column you are looking for is missing, consider customizing Zoho CRM Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	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 component to read data or in API Destination component to read/write data:

List Module Settings using API Source

Zoho CRM

List Module Settings

SSIS API Source - Read from table or endpoint

List Module Settings using API Destination

Zoho CRM

List Module Settings

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

List module settings

SELECT * FROM get_module_settings
WITH
(
    "module" = 'abcd-1234-module'
)

SQL Server

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

List module settings

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_module_settings
WITH
(
    "module" = ''abcd-1234-module''
)';

EXEC (@MyQuery) AT [LS_TO_ZOHO_CRM_IN_GATEWAY];