ZohoCreatorApi

The ZohoCreatorApi MCP Server offers a comprehensive suite of tools for interacting with Zoho Creator applications. Users can efficiently manage and manipulate data within their apps, enabling actions such as:

Available Tools

ZohoCreatorApi.FetchZohoAppSections

Fetch details of sections and components in Zoho Creator apps.

Parameters

• zoho_account_owner_name (string, required) The account owner’s username in Zoho. Required to fetch data for the specified application.
• zoho_application_link_name (string, required) The unique link name of the Zoho Creator application whose sections and components you want to fetch.

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.FetchRecordDetail

Fetches detailed view data of a record by ID.

Parameters

• application_private_link (string, required) The private link identifier of the Zoho application, necessary for accessing the specific record’s detail view.
• account_owner_name (string, required) The name of the account owner in Zoho. This specifies the owner of the account to which the app belongs.
• application_link_name (string, required) The unique identifier or slug for the specific Zoho app to query. This determines which app’s data is accessed.
• report_link_name (string, required) The link name of the report from which to fetch the record detail. It identifies the specific report in the Zoho app.
• record_id (string, required) The unique identifier of the record to fetch detailed information for. It should be a string corresponding to the record’s ID in the Zoho app.

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.FetchZohoFormFieldsMetadata

Fetches metadata of fields in a Zoho Creator form.

Parameters

• account_owner_name (string, required) The Zoho account owner’s username. Required to identify the specific account that owns the application.
• application_link_name (string, required) The unique link name of the Zoho Creator application. It identifies which application’s form metadata to fetch.
• form_identifier (string, required) The unique identifier or link name of the Zoho Creator form to fetch metadata for.

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.FetchZohoReportsMeta

Fetches meta information of reports in Zoho Creator.

Parameters

• zoho_account_owner_name (string, required) The name of the account owner in Zoho. Used to identify which account’s report metadata to fetch.
• zoho_app_link_name (string, required) The unique link name of the Zoho Creator application to fetch report metadata from. This identifies the specific app within your Zoho account.

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.UpdateZohoCreatorReportRecords

Update records in a Zoho Creator report.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• account_owner_name (string, optional) The username of the owner of the Zoho account associated with the application. Required for determining access and permissions. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• application_link_name (string, optional) The unique identifier (link name) of the Zoho Creator application. Required to specify the target app for updating records. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• report_link_name (string, optional) The name or identifier of the report in Zoho Creator whose records you want to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• process_until_limit_enabled (boolean, optional) Set to true to process records until reaching a limit of 200. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.FetchZohoRecords

Fetch records from a Zoho Creator report.

Parameters

• account_owner_identifier (string, required) The unique identifier for the Zoho account owner. Required to fetch the report data.
• application_link_name (string, required) The unique identifier for the Zoho Creator application. It specifies which app’s report to fetch.
• report_link_name (string, required) The unique link name of the Zoho Creator report to fetch records from.
• start_record_index (integer, optional) The starting index of records to retrieve from the report. Must be an integer.
• record_limit (integer, optional) The maximum number of records to retrieve, up to 200.
• filter_criteria (string, optional) Specify conditions to filter records. Use Zoho Creator query format for filtering.

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.DeleteReportRecords

Delete records from a specified Zoho Creator report.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• account_owner_name (string, optional) The name of the Zoho account owner. It identifies whose account the deletion should occur under. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• application_link_name (string, optional) The unique identifier for the application within Zoho Creator. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• report_identifier (string, optional) The name of the report from which records should be deleted. Must match the link name configured in Zoho Creator. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• process_records_up_to_limit (boolean, optional) Boolean to enable processing records up to the 200-record limit per request. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.FetchZohoCreatorPagesMeta

Fetches meta information of pages in a Zoho Creator app.

Parameters

• account_owner_name (string, required) The name of the account owner in Zoho. This identifies the owner of the application for which the page metadata is fetched.
• zoho_app_link_name (string, required) The unique identifier for the Zoho Creator application to fetch page metadata.

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.GetApplicationMetaInfo

Fetches meta information of accessible applications.

Parameters

This tool does not take any parameters. Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.InsertRecordsInZohoForm

Add records to a form in Zoho Creator.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• zoho_account_owner_name (string, optional) The name of the account owner in Zoho. This is required to identify which account the records should be added to. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• application_link_name (string, optional) The unique identifier of the application in which the form is located. This is necessary to specify the target Zoho Creator application. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• form_link_name (string, optional) The unique link name of the form in Zoho Creator where records will be added. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.UpdateZohoRecord

Update a specific record in Zoho Creator by ID.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• zoho_account_owner_name (string, optional) The account owner’s name in Zoho. Used to identify the correct Zoho Creator account for the update operation. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• application_link_name (string, optional) The unique name of the Zoho Creator application where the record resides. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• report_link_name (string, optional) The string identifier of the report in Zoho Creator where the record is located. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• record_id (string, optional) The unique identifier for the record to be updated in Zoho Creator. This ID specifies which record in the report will be modified. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.FetchZohoRecordDetail

Fetches detailed view data of a Zoho record by ID.

Parameters

• account_owner_name (string, required) The name of the account owner in Zoho to fetch the record for. This identifies the specific account under which the record exists.
• application_identifier (string, required) The name of the application in Zoho used to uniquely identify which app’s record details are to be fetched.
• report_link_name (string, required) The specific name of the report in Zoho from which the data will be fetched.
• record_id (string, required) The unique ID of the Zoho record to fetch its detailed information.

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.DeleteZohoRecord

Delete a specific record in Zoho Creator by ID.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• zoho_account_owner_name (string, optional) The account owner’s name in Zoho. Required to specify which user’s account to access. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• application_link_name (string, optional) The unique identifier for the Zoho Creator application. Provide this to specify which application contains the record to delete. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• report_link_name (string, optional) The unique name of the report in Zoho where the record is listed. This identifies which report contains the record to be deleted. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• record_id (string, optional) The unique ID of the record to be deleted from Zoho Creator. This must match the ID displayed in the relevant Zoho report. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.CreateBulkReadJob

Initiate a bulk read job to export records.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• account_owner_name (string, optional) The name of the account owner in Zoho for whom the bulk read job is being created. This should match the official account details. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• application_link_name (string, optional) The name of the application within Zoho to export records from. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• report_reference_name (string, optional) Specifies the unique link or name of the report from which records will be exported in Zoho. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.FetchZohoReportRecords

Fetch records displayed by a Zoho Creator report.

Parameters

• zoho_private_link (string, required) The private link URL or identifier for accessing a specific Zoho Creator report.
• account_owner_name (string, required) The username of the Zoho account owner. Required to identify the correct account for fetching report records.
• zoho_application_link_name (string, required) The unique link name of the Zoho Creator application from which to fetch report records.
• report_link_name (string, required) The unique link name of the Zoho report to fetch records from. It’s required to specify which report to access.
• record_fetch_start_index (integer, optional) Specify the starting index for records to be fetched. Use an integer value.
• record_limit (integer, optional) Specify the maximum number of records to fetch, up to 200.
• filter_criteria (string, optional) A string to filter records based on specific conditions, formatted as ‘Field_Name Operator Value’.

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.GetBulkReadJobDetails

Retrieve details of a completed bulk read job in Zoho Creator.

Parameters

• account_owner_name (string, required) The name of the account owner in Zoho. Required for identifying the correct account.
• application_link_name (string, required) The name of the Zoho Creator application. Used to identify which application’s bulk read job details are being retrieved.
• report_link_name (string, required) The link name of the report for which the bulk read job details are requested. This is required to specify the report in Zoho Creator.
• job_id (string, required) The unique identifier for the bulk read job to retrieve details for. This should be a string value.

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.FetchWorkspaceAppMeta

Fetch meta information of applications in a workspace.

Parameters

• workspace_account_owner_name (string, required) The name of the account owner for the workspace you want to fetch application meta information from.

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.FetchZohoFormMetaInformation

Fetch meta information of Zoho Creator app forms.

Parameters

• zoho_account_owner_name (string, required) The name of the account owner for the Zoho Creator application. Required for authentication and identifying the account context.
• zoho_app_link_name (string, required) The unique link name of the Zoho Creator application. This identifies the app whose form meta information is to be fetched.

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

ZohoCreatorApi.AddRecordsToZohoForm

Add multiple records to a Zoho Creator form efficiently.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• form_private_link (string, optional) The unique identifier for accessing a specific form in Zoho Creator securely. Required for access control. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• zoho_account_owner_name (string, optional) The account owner’s name associated with the Zoho Creator application. This is needed to authenticate and route the records correctly. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• application_link_name (string, optional) The unique identifier for the Zoho application where the form resides. Required to locate the specific application. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• zoho_form_link_name (string, optional) The unique link name of the form in Zoho Creator where records will be added. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Secrets

This tool requires the following secrets: ZOHO_SERVER_URL (learn how to configure secrets)

Reference

Below is a reference of enumerations used by some of the tools in the ZohoCreatorApi MCP Server:

ToolMode

• GET_REQUEST_SCHEMA: get_request_schema
• EXECUTE: execute

Secrets

This MCP Server requires the ZOHO_SERVER_URL secret to be configured. Learn how to configure secrets.

Getting your Zoho Server URL

The Zoho Server URL is the base URL for your Zoho account’s data center. Zoho operates in multiple data centers around the world, and you must use the correct URL for your account.

Your Zoho Server URL depends on which data center your account is registered in:

To determine which data center your account uses:

1. Log in to your Zoho Creator account
2. Look at the URL in your browser’s address bar
3. The domain (.com, .eu, .in, .com.au, or .com.cn) indicates your data center

For example, if you access Zoho Creator at https://creator.zoho.eu, your server URL is https://creator.zoho.eu.

The server URL is used as the base for all API requests. For example, when retrieving application metadata, the full URL would be constructed as:

{zoho_server_url}/creator/v2/meta/{account_owner_name}/{app_link_name}/sections

Which would become https://creator.zoho.com/creator/v2/meta/{account_owner_name}/{app_link_name}/sections for US accounts.

Auth

The ZohoCreatorApi MCP Server uses the Auth Provider with id arcade-zoho to connect to users’ Zoho Creator accounts. In order to use the MCP Server, you will need to configure the arcade-zoho auth provider.

Learn how to configure the Zoho auth provider in the Zoho auth provider documentation.

pip install arcade_zoho_creator_api