Install
openclaw skills install @byungkyu/zoho-crmZoho CRM API integration with managed OAuth. Manage leads, contacts, accounts, deals, and other CRM records. Use this skill when users want to read, create, update, or delete CRM records, search contacts, manage sales pipelines, access organization settings, manage users, or retrieve module metadata in Zoho CRM. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway). Requires network access and valid Maton API key. Calls run through the maton CLI with OAuth login; default to read and list calls, and confirm every write or new connection with the user.
openclaw skills install @byungkyu/zoho-crmAccess the Zoho CRM API with managed OAuth authentication. Manage leads, contacts, accounts, deals, and other CRM modules with full CRUD operations including search and bulk operations. Also supports organization details, user management, and module metadata retrieval.
All access runs through the Maton gateway and the maton CLI.
maton login --oauth # authenticate once (OAuth, recommended)
maton connection create zoho-crm # connect the account (needs user approval)
maton api '/zoho-crm/crm/v8/org' # first call
npm install -g @maton/cli
brew install maton-ai/cli/maton
maton login --oauth
Opens the OAuth login page in the browser and waits for authorization. Once complete, it creates a profile in config.toml (eg. $HOME/.config/maton/config.toml) and stores the access and refresh tokens in the operating system's credential store (Keychain on macOS, Credential Manager on Windows, Secret Service on Linux), auto-renewed on expiry. The CLI reads them when it needs them; nothing else should.
maton login --interactive
Requires manually copying an API key from Settings, which is error prone. Once complete, it also creates a profile in config.toml and stores the key in the same credential store. It is preferred over export MATON_API_KEY=..., which exposes a long-lived credential to every child process. When MATON_API_KEY is set, it overrides the active profile. If the CLI cannot be installed at all, see Appendix: Environments Without the CLI for the raw HTTP form and the rules for handling the key.
maton whoami --json
{
"authenticated": true,
"profile_name": "alice@example.com",
"auth_type": "oauth"
}
authenticated is false, stop and login again via maton login --oauth.auth_type is api_key, it is recommended to login via maton login --oauth and avoid keeping a long-lived credential.maton connection list zoho-crm --status ACTIVE
{
"connections": [
{
"connection_id": "{connection_id}",
"status": "ACTIVE",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=5e9...",
"app": "zoho-crm",
"method": "OAUTH2",
"metadata": {}
}
]
}
Refer to maton connection list --help for possible flags and values.
Requires explicit user approval. Confirm that the user intends to authorize Zoho CRM access before running this. Never create a connection on your own initiative.
maton connection create zoho-crm
Refer to maton connection create --help for possible flags and values.
maton connection get {connection_id}
{
"connection": {
"connection_id": "{connection_id}",
"status": "PENDING",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=5e9...",
"app": "zoho-crm",
"metadata": {}
}
}
Open the returned URL in a browser to complete authorizing Zoho CRM. If Zoho CRM offers scope selection, choose only the scopes the current task needs.
maton connection delete {connection_id} --yes
If there are multiple Zoho CRM connections, specify which one to use so requests go to the intended account:
maton api '/zoho-crm/crm/v8/org' --connection {connection_id}
Zoho CRM has no typed maton zoho-crm commands yet, so every call goes through maton api.
maton api '/zoho-crm/crm/v8/org'
Paths are /zoho-crm/{native-api-path}. The gateway forwards everything after the app segment to www.zohoapis.com/crm/v8 and injects the credential for the connection. Query strings, custom headers (except Host and Authorization), and all HTTP methods pass through. Send a JSON body with --input -:
maton api -X POST '/zoho-crm/{native-api-path}' -H 'Content-Type: application/json' --input - <<'JSON'
{"key": "value"}
JSON
Refer to maton api --help for possible flags and values.
maton login --oauth, the token is held by the operating system's credential store and the CLI renews it on its own. Do not print it, write it to a file, pass it on a command line, or run maton token to look at one — only to hand it to a program that needs it.config.toml, or any other credential file — not for this skill, not for another application, and not to "check" that auth works (use maton whoami). Let the CLI use its own stored credential; the agent never needs the value. The same applies to unrelated secrets on the machine: .env files, SSH keys, cloud CLI credentials, and browser profiles are out of scope for an API gateway and must not be read or transmitted.api.maton.ai. Prefer endpoints that work with the gateway-injected connection credential.maton connection delete {connection_id}).maton connection create zoho-crm. Never create connections on the agent's own initiative.--connection when the user has multiple connections for this app, and -p/--profile when they have multiple Maton accounts. Do not let an ambiguous default decide where a write lands.Zoho CRM organizes data into modules. Core modules include:
| Module | API Name | Description |
|---|---|---|
| Leads | Leads | Potential customers |
| Contacts | Contacts | Individual people |
| Accounts | Accounts | Organizations/companies |
| Deals | Deals | Sales opportunities |
| Campaigns | Campaigns | Marketing campaigns |
| Tasks | Tasks | To-do items |
| Calls | Calls | Phone call logs |
| Events | Events | Calendar appointments |
| Products | Products | Items you sell |
maton api '/zoho-crm/crm/v8/{module_api_name}?fields={field1},{field2}'
Query Parameters:
| Parameter | Type | Description |
|---|---|---|
fields | string | Required. Comma-separated field API names (max 50) |
page | integer | Page number (default: 1) |
per_page | integer | Records per page (default/max: 200) |
sort_by | string | Sort by: id, Created_Time, or Modified_Time |
sort_order | string | asc or desc (default) |
cvid | long | Custom view ID |
page_token | string | For >2000 records pagination |
Example - List Leads:
maton api '/zoho-crm/crm/v8/Leads?fields=First_Name,Last_Name,Email,Phone,Company'
Response:
{
"data": [
{
"First_Name": "Christopher",
"Email": "christopher-maclead@noemail.invalid",
"Last_Name": "Maclead (Sample)",
"Phone": "555-555-5555",
"Company": "Rangoni Of Florence",
"id": "7243485000000597000"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"sort_by": "id",
"sort_order": "desc",
"more_records": false,
"next_page_token": null
}
}
Example - List Contacts:
maton api '/zoho-crm/crm/v8/Contacts?fields=First_Name,Last_Name,Email,Phone'
Example - List Accounts:
maton api '/zoho-crm/crm/v8/Accounts?fields=Account_Name,Website,Phone'
Example - List Deals:
maton api '/zoho-crm/crm/v8/Deals?fields=Deal_Name,Stage,Amount'
maton api '/zoho-crm/crm/v8/{module_api_name}/{record_id}'
Example:
maton api '/zoho-crm/crm/v8/Leads/7243485000000597000'
maton api -X POST '/zoho-crm/crm/v8/{module_api_name}' -H 'Content-Type: application/json' --input - <<'JSON'
{
"data": [
{
"field_api_name": "value"
}
]
}
JSON
Mandatory Fields by Module:
| Module | Required Fields |
|---|---|
| Leads | Last_Name |
| Contacts | Last_Name |
| Accounts | Account_Name |
| Deals | Deal_Name, Stage |
| Tasks | Subject |
| Calls | Subject, Call_Type, Call_Start_Time, Call_Duration |
| Events | Event_Title, Start_DateTime, End_DateTime |
Example - Create Lead:
maton api -X POST '/zoho-crm/crm/v8/Leads' -H 'Content-Type: application/json' --input - <<'JSON'
{
"data": [
{
"Last_Name": "Smith",
"First_Name": "John",
"Email": "john.smith@example.com",
"Company": "Acme Corp",
"Phone": "+1-555-0123"
}
]
}
JSON
Response:
{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2026-02-06T01:10:56-08:00",
"Modified_By": {
"name": "User Name",
"id": "7243485000000590001"
},
"Created_Time": "2026-02-06T01:10:56-08:00",
"id": "7243485000000619001",
"Created_By": {
"name": "User Name",
"id": "7243485000000590001"
}
},
"message": "record added",
"status": "success"
}
]
}
Example - Create Contact:
maton api -X POST '/zoho-crm/crm/v8/Contacts' -H 'Content-Type: application/json' --input - <<'JSON'
{
"data": [
{
"Last_Name": "Doe",
"First_Name": "Jane",
"Email": "jane.doe@example.com",
"Phone": "+1-555-9876"
}
]
}
JSON
Example - Create Account:
maton api -X POST '/zoho-crm/crm/v8/Accounts' -H 'Content-Type: application/json' --input - <<'JSON'
{
"data": [
{
"Account_Name": "Acme Corporation",
"Website": "https://acme.com",
"Phone": "+1-555-1234"
}
]
}
JSON
maton api -X PUT '/zoho-crm/crm/v8/{module_api_name}' -H 'Content-Type: application/json' --input - <<'JSON'
{
"data": [
{
"id": "record_id",
"field_api_name": "updated_value"
}
]
}
JSON
Example:
maton api -X PUT '/zoho-crm/crm/v8/Leads' -H 'Content-Type: application/json' --input - <<'JSON'
{
"data": [
{
"id": "7243485000000619001",
"Phone": "+1-555-9999",
"Company": "Updated Company Name"
}
]
}
JSON
Response:
{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2026-02-06T01:11:01-08:00",
"Modified_By": {
"name": "User Name",
"id": "7243485000000590001"
},
"Created_Time": "2026-02-06T01:10:56-08:00",
"id": "7243485000000619001",
"Created_By": {
"name": "User Name",
"id": "7243485000000590001"
}
},
"message": "record updated",
"status": "success"
}
]
}
maton api -X DELETE '/zoho-crm/crm/v8/{module_api_name}?ids={record_id1},{record_id2}'
Query Parameters:
| Parameter | Type | Description |
|---|---|---|
ids | string | Comma-separated record IDs (required, max 100) |
wf_trigger | boolean | Execute workflows (default: true) |
Example:
maton api -X DELETE '/zoho-crm/crm/v8/Leads?ids=7243485000000619001'
Response:
{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "7243485000000619001"
},
"message": "record deleted",
"status": "success"
}
]
}
maton api '/zoho-crm/crm/v8/{module_api_name}/search'
Query Parameters (one required):
| Parameter | Type | Description |
|---|---|---|
criteria | string | Search criteria (e.g., (Last_Name:equals:Smith)) |
email | string | Search by email address |
phone | string | Search by phone number |
word | string | Global text search |
page | integer | Page number |
per_page | integer | Records per page (max 200) |
Criteria Format: ((field_api_name:operator:value) and/or (...))
Operators:
equals, not_equal, starts_with, inequals, not_equal, greater_than, less_than, between, inequals, not_equalExample - Search by email:
maton api '/zoho-crm/crm/v8/Leads/search?email=christopher-maclead@noemail.invalid'
Example - Search by criteria:
maton api '/zoho-crm/crm/v8/Leads/search?criteria={criteria}'
Response:
{
"data": [
{
"First_Name": "Christopher",
"Email": "christopher-maclead@noemail.invalid",
"Last_Name": "Maclead (Sample)",
"id": "7243485000000597000"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}
Retrieve your Zoho CRM organization details.
maton api '/zoho-crm/crm/v8/org'
Example:
maton api '/zoho-crm/crm/v8/org'
Response:
{
"org": [
{
"id": "7243485000000020005",
"company_name": "Acme Corp",
"domain_name": "org123456789",
"primary_email": "admin@example.com",
"phone": "555-555-5555",
"currency": "US Dollar - USD",
"currency_symbol": "$",
"iso_code": "USD",
"time_zone": "PST",
"country_code": "US",
"zgid": "123456789",
"type": "production",
"mc_status": false,
"license_details": {
"paid": true,
"paid_type": "enterprise",
"users_license_purchased": 10,
"trial_expiry": null
}
}
]
}
Retrieve users in your Zoho CRM organization.
maton api '/zoho-crm/crm/v8/users'
Query Parameters:
| Parameter | Type | Description |
|---|---|---|
type | string | Filter by user type: AllUsers, ActiveUsers, DeactiveUsers, ConfirmedUsers, NotConfirmedUsers, DeletedUsers, ActiveConfirmedUsers, AdminUsers, ActiveConfirmedAdmins, CurrentUser |
page | integer | Page number (default: 1) |
per_page | integer | Records per page (default/max: 200) |
ids | string | Comma-separated user IDs (max 100) |
Example - List all users:
maton api '/zoho-crm/crm/v8/users?type=AllUsers'
Response:
{
"users": [
{
"id": "7243485000000590001",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"email": "john.doe@example.com",
"status": "active",
"confirm": true,
"role": {
"name": "CEO",
"id": "7243485000000026005"
},
"profile": {
"name": "Administrator",
"id": "7243485000000026011"
},
"time_zone": "PST",
"country": "US",
"locale": "en_US"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}
Example - Get specific user:
maton api '/zoho-crm/crm/v8/users/7243485000000590001'
Retrieve metadata about all available CRM modules.
maton api '/zoho-crm/crm/v8/settings/modules'
Query Parameters:
| Parameter | Type | Description |
|---|---|---|
status | string | Filter by status: user_hidden, system_hidden, scheduled_for_deletion, visible |
Example:
maton api '/zoho-crm/crm/v8/settings/modules'
Response:
{
"modules": [
{
"api_name": "Leads",
"module_name": "Leads",
"singular_label": "Lead",
"plural_label": "Leads",
"api_supported": true,
"creatable": true,
"editable": true,
"deletable": true,
"viewable": true,
"status": "visible",
"generated_type": "default",
"id": "7243485000000002175",
"profiles": [
{"name": "Administrator", "id": "7243485000000026011"}
]
}
]
}
Retrieve field metadata for a specific module.
maton api '/zoho-crm/crm/v8/settings/fields?module={module_api_name}'
Query Parameters:
| Parameter | Type | Description |
|---|---|---|
module | string | Required. API name of the module (e.g., Leads, Contacts) |
type | string | all for all fields, unused for unused fields only |
Example:
maton api '/zoho-crm/crm/v8/settings/fields?module=Leads'
Response:
{
"fields": [
{
"api_name": "Last_Name",
"field_label": "Last Name",
"data_type": "text",
"system_mandatory": true,
"custom_field": false,
"visible": true,
"searchable": true,
"sortable": true,
"id": "7243485000000002613"
}
]
}
Retrieve layout metadata for a specific module.
maton api '/zoho-crm/crm/v8/settings/layouts?module={module_api_name}'
Query Parameters:
| Parameter | Type | Description |
|---|---|---|
module | string | Required. API name of the module (e.g., Leads, Contacts) |
Example:
maton api '/zoho-crm/crm/v8/settings/layouts?module=Leads'
Response:
{
"layouts": [
{
"id": "7243485000000091055",
"name": "Standard",
"api_name": "Standard",
"status": "active",
"visible": true,
"profiles": [
{"name": "Administrator", "id": "7243485000000026011"}
],
"sections": [
{
"display_label": "Lead Information",
"api_name": "Lead_Information",
"sequence_number": 1,
"fields": [...]
}
]
}
]
}
Retrieve roles in your Zoho CRM organization.
maton api '/zoho-crm/crm/v8/settings/roles'
Example:
maton api '/zoho-crm/crm/v8/settings/roles'
Response:
{
"roles": [
{
"id": "7243485000000026005",
"name": "CEO",
"display_label": "CEO",
"share_with_peers": true,
"description": null,
"reporting_to": null
},
{
"id": "7243485000000026008",
"name": "Manager",
"display_label": "Manager",
"share_with_peers": false,
"reporting_to": {
"name": "CEO",
"id": "7243485000000026005"
}
}
]
}
Example - Get specific role:
maton api '/zoho-crm/crm/v8/settings/roles/7243485000000026005'
Retrieve profiles (permission sets) in your Zoho CRM organization.
maton api '/zoho-crm/crm/v8/settings/profiles'
Example:
maton api '/zoho-crm/crm/v8/settings/profiles'
Response:
{
"profiles": [
{
"id": "7243485000000026011",
"name": "Administrator",
"display_label": "Administrator",
"type": "normal_profile",
"custom": false,
"description": null
},
{
"id": "7243485000000026014",
"name": "Standard",
"display_label": "Standard",
"type": "normal_profile",
"custom": false,
"description": null
}
]
}
Example - Get specific profile:
maton api '/zoho-crm/crm/v8/settings/profiles/7243485000000026011'
Zoho CRM uses page-based pagination with optional page tokens for large datasets:
maton api '/zoho-crm/crm/v8/{module_api_name}?fields=First_Name,Last_Name&page=1&per_page=50'
Response includes pagination info:
{
"data": [...],
"info": {
"per_page": 50,
"count": 50,
"page": 1,
"sort_by": "id",
"sort_order": "desc",
"more_records": true,
"next_page_token": "token_value",
"page_token_expiry": "2026-02-07T01:10:56-08:00"
}
}
page parameter (increment each request)page_token from previous responsefields parameter is required for list operations (max 50 fields)Leads, not leads)Zoho CRM has no typed accessor yet, so calls go through the api passthrough, which takes the app and the path after it. login() opens a browser once per machine and writes the session to the SDK's own store — maton login does not carry over, and the SDK never signs in implicitly.
Python
pip install maton-ai
from maton_ai import Maton, login
# login()
maton = Maton()
# maton = Maton(api_key="...")
result = maton.api.get("zoho-crm", "/crm/v8/org")
JavaScript
npm install @maton/sdk
import { Maton, login } from "@maton/sdk";
// await login()
const maton = new Maton();
// const maton = new Maton({ apiKey: "..." });
const result = await maton.api.get("zoho-crm", "/crm/v8/org");
| Status | Meaning |
|---|---|
| 400 | Missing Zoho CRM connection |
| 401 | Invalid, missing, or expired Maton credential |
| 429 | Rate limited (10 requests/second per account) |
| 500 | Internal Server Error |
| 4xx/5xx | Passthrough error from the Zoho CRM API |
Errors from Zoho CRM are passed through with their original status codes and response bodies.
maton whoami --json
"authenticated": false — login again with maton login --oauth."auth_type": "api_key" — prefer maton login --oauth so no long-lived key sits on the machine.maton whoami is the check.Then confirm the app is connected:
maton connection list zoho-crm --status ACTIVE
Paths passed to maton api must start with /zoho-crm/:
maton api '/zoho-crm/crm/v8/org'maton api '/crm/v8/org'A 500 may mean the Zoho CRM authorization expired. With the user's approval, create a new connection (maton connection create zoho-crm) and complete authorization; once it is ACTIVE, delete the stale connection so the gateway uses the new one.
| Code | Description |
|---|---|
OAUTH_SCOPE_MISMATCH | OAuth token lacks required permissions for the endpoint |
MANDATORY_NOT_FOUND | Required field is missing |
INVALID_DATA | Data type mismatch or format error |
DUPLICATE_DATA | Record violates unique field constraint |
RECORD_NOT_FOUND | The specified record ID does not exist |
maton api.--paginate walks every page and -q/--jq trims the response before it reaches you. On typed commands, --jq requires --json.maton api; Host and Authorization are set by the gateway.Everything above uses the CLI, which holds the credential itself and never exposes it to the caller. Use the raw HTTP form below only where the CLI cannot be installed — a locked-down container, a CI step, a sandbox with no package manager. If maton is available, maton api does the same job without handling a secret.
Calling https://api.maton.ai/ directly means holding a long-lived Maton API key in the process environment, where it is readable by every child process and easy to leak into logs, crash dumps, shell history, and pasted output. Handle it accordingly:
[ -n "$MATON_API_KEY" ] && echo "MATON_API_KEY is set" || echo "MATON_API_KEY is not set"
.env, or a script makes it permanent. Let the environment that starts the session supply it — a CI secret store, a container secret, a secrets manager.-H "Authorization: Bearer $MATON_API_KEY"), where it lands in ps output and shell history. Feed the header in on stdin instead, as below.api.maton.ai. It is not a credential for Zoho CRM or any other third-party host.curl --config - reads the header from stdin, so the key is never a command-line argument and never reaches ps or shell history. Query values must be URL-encoded (is:unread becomes is%3Aunread).
curl --config - "https://api.maton.ai/zoho-crm/crm/v8/org" <<EOF
header = "Authorization: Bearer $MATON_API_KEY"
header = "User-Agent: maton-zoho-crm-skill/1.1"
# Pin a specific connection when the account has more than one:
# header = "Maton-Connection: {connection_id}"
EOF
The same rules as the CLI apply to every request made this way: read-only calls first, and explicit user confirmation before any POST, PUT, PATCH, or DELETE.