Install
openclaw skills install 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.
openclaw skills install 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.
# List leads
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Leads?fields=First_Name,Last_Name,Email')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
https://api.maton.ai/zoho-crm/crm/v8/{endpoint}
Maton proxies requests to www.zohoapis.com/crm/v8 and automatically injects your OAuth token.
All requests require the Maton API key in the Authorization header:
Authorization: Bearer $MATON_API_KEY
Environment Variable: Set your API key as MATON_API_KEY:
export MATON_API_KEY="YOUR_API_KEY"
Manage your Zoho CRM OAuth connections at https://api.maton.ai.
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections?app=zoho-crm&status=ACTIVE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
python <<'EOF'
import urllib.request, os, json
data = json.dumps({'app': 'zoho-crm'}).encode()
req = urllib.request.Request('https://api.maton.ai/connections', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections/{connection_id}')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Response:
{
"connection": {
"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=...",
"app": "zoho-crm",
"metadata": {}
}
}
Open the returned url in a browser to complete OAuth authorization.
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections/{connection_id}', method='DELETE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
If you have multiple Zoho CRM connections, specify which one to use with the Maton-Connection header:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Leads?fields=First_Name,Last_Name,Email')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Maton-Connection', '{connection_id}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
If you have multiple connections, always include this header to ensure requests go to the intended account.
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 |
GET /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:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Leads?fields=First_Name,Last_Name,Email,Phone,Company')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
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:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Contacts?fields=First_Name,Last_Name,Email,Phone')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Example - List Accounts:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Accounts?fields=Account_Name,Website,Phone')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Example - List Deals:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Deals?fields=Deal_Name,Stage,Amount')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
GET /zoho-crm/crm/v8/{module_api_name}/{record_id}
Example:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Leads/7243485000000597000')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
POST /zoho-crm/crm/v8/{module_api_name}
Content-Type: application/json
{
"data": [
{
"field_api_name": "value"
}
]
}
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:
python <<'EOF'
import urllib.request, os, json
data = json.dumps({
"data": [{
"Last_Name": "Smith",
"First_Name": "John",
"Email": "john.smith@example.com",
"Company": "Acme Corp",
"Phone": "+1-555-0123"
}]
}).encode()
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Leads', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
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:
python <<'EOF'
import urllib.request, os, json
data = json.dumps({
"data": [{
"Last_Name": "Doe",
"First_Name": "Jane",
"Email": "jane.doe@example.com",
"Phone": "+1-555-9876"
}]
}).encode()
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Contacts', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Example - Create Account:
python <<'EOF'
import urllib.request, os, json
data = json.dumps({
"data": [{
"Account_Name": "Acme Corporation",
"Website": "https://acme.com",
"Phone": "+1-555-1234"
}]
}).encode()
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Accounts', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
PUT /zoho-crm/crm/v8/{module_api_name}
Content-Type: application/json
{
"data": [
{
"id": "record_id",
"field_api_name": "updated_value"
}
]
}
Example:
python <<'EOF'
import urllib.request, os, json
data = json.dumps({
"data": [{
"id": "7243485000000619001",
"Phone": "+1-555-9999",
"Company": "Updated Company Name"
}]
}).encode()
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Leads', data=data, method='PUT')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
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"
}
]
}
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:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Leads?ids=7243485000000619001', method='DELETE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Response:
{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "7243485000000619001"
},
"message": "record deleted",
"status": "success"
}
]
}
GET /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:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/Leads/search?email=christopher-maclead@noemail.invalid')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Example - Search by criteria:
python <<'EOF'
import urllib.request, os, json
import urllib.parse
criteria = urllib.parse.quote('(Last_Name:starts_with:Smith)')
req = urllib.request.Request(f'https://api.maton.ai/zoho-crm/crm/v8/Leads/search?criteria={criteria}')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
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.
GET /zoho-crm/crm/v8/org
Example:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/org')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
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.
GET /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:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/users?type=AllUsers')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
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:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/users/7243485000000590001')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Retrieve metadata about all available CRM modules.
GET /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:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/settings/modules')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
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.
GET /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:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/settings/fields?module=Leads')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
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.
GET /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:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/settings/layouts?module=Leads')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
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.
GET /zoho-crm/crm/v8/settings/roles
Example:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/settings/roles')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
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:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/settings/roles/7243485000000026005')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Retrieve profiles (permission sets) in your Zoho CRM organization.
GET /zoho-crm/crm/v8/settings/profiles
Example:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/settings/profiles')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
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:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-crm/crm/v8/settings/profiles/7243485000000026011')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
Zoho CRM uses page-based pagination with optional page tokens for large datasets:
GET /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 responseconst response = await fetch(
'https://api.maton.ai/zoho-crm/crm/v8/Leads?fields=First_Name,Last_Name,Email',
{
headers: {
'Authorization': `Bearer ${process.env.MATON_API_KEY}`
}
}
);
const data = await response.json();
import os
import requests
response = requests.get(
'https://api.maton.ai/zoho-crm/crm/v8/Leads',
headers={'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'},
params={'fields': 'First_Name,Last_Name,Email'}
)
data = response.json()
fields parameter is required for list operations (max 50 fields)Leads, not leads)curl -g when URLs contain brackets to disable glob parsingjq or other commands, environment variables like $MATON_API_KEY may not expand correctly in some shell environments| Status | Meaning |
|---|---|
| 400 | Missing Zoho CRM connection, missing required parameter, or invalid request |
| 401 | Invalid or missing Maton API key, or OAuth scope mismatch |
| 404 | Resource not found |
| 429 | Rate limited |
| 4xx/5xx | Passthrough error from Zoho CRM API |
| 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_KEY environment variable is set:echo $MATON_API_KEY
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
zoho-crm. For example:https://api.maton.ai/zoho-crm/crm/v8/Leadshttps://api.maton.ai/crm/v8/Leads