4.0 KiB
4.0 KiB
Zoho CRM Routing Reference
App name: zoho-crm
Base URL proxied: www.zohoapis.com
API Path Pattern
/zoho-crm/crm/v8/{resource}
Common Endpoints
Records
# List records (fields required)
GET /zoho-crm/crm/v8/{module_api_name}?fields={field1},{field2}
# Get record
GET /zoho-crm/crm/v8/{module_api_name}/{record_id}
# Create records
POST /zoho-crm/crm/v8/{module_api_name}
Content-Type: application/json
{
"data": [
{
"field_api_name": "value"
}
]
}
# Update records
PUT /zoho-crm/crm/v8/{module_api_name}
Content-Type: application/json
{
"data": [
{
"id": "record_id",
"field_api_name": "updated_value"
}
]
}
# Delete records
DELETE /zoho-crm/crm/v8/{module_api_name}?ids={id1},{id2}
Search
# Search by criteria
GET /zoho-crm/crm/v8/{module_api_name}/search?criteria=(Last_Name:equals:Smith)
# Search by email
GET /zoho-crm/crm/v8/{module_api_name}/search?email=user@example.com
# Search by phone
GET /zoho-crm/crm/v8/{module_api_name}/search?phone=555-1234
# Global text search
GET /zoho-crm/crm/v8/{module_api_name}/search?word=searchterm
Organization
# Get organization details
GET /zoho-crm/crm/v8/org
Users
# List users (type: AllUsers, ActiveUsers, AdminUsers, CurrentUser, etc.)
GET /zoho-crm/crm/v8/users?type=AllUsers
# Get specific user
GET /zoho-crm/crm/v8/users/{user_id}
Settings / Metadata
# List all modules
GET /zoho-crm/crm/v8/settings/modules
# Get fields for a module
GET /zoho-crm/crm/v8/settings/fields?module={module_api_name}
# Get layouts for a module
GET /zoho-crm/crm/v8/settings/layouts?module={module_api_name}
# List roles
GET /zoho-crm/crm/v8/settings/roles
# Get specific role
GET /zoho-crm/crm/v8/settings/roles/{role_id}
# List profiles
GET /zoho-crm/crm/v8/settings/profiles
# Get specific profile
GET /zoho-crm/crm/v8/settings/profiles/{profile_id}
Available Modules
| 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 for sale |
Mandatory Fields
| Module | Required Fields |
|---|---|
| Leads | Last_Name |
| Contacts | Last_Name |
| Accounts | Account_Name |
| Deals | Deal_Name, Stage |
| Tasks | Subject |
Search Operators
- Text:
equals,not_equal,starts_with,in - Date/Number:
equals,not_equal,greater_than,less_than,between,in - Boolean:
equals,not_equal
Notes
- The
fieldsparameter is required for list operations (max 50 fields) - Module API names are case-sensitive (e.g.,
Leads, notleads) - Maximum 100 records per create/update/delete request
- Maximum 200 records returned per GET request
- Use
page_tokenfor >2,000 records (expires after 24 hours) - If you receive a scope error, contact Maton support at support@maton.ai with the specific operations/APIs you need and your use-case
- Empty datasets return HTTP 204 (No Content)