This article lists every Zoho CRM API endpoint the integration calls, grouped by data type. Use it to confirm which endpoints the integration depends on — for firewall allow-listing, OAuth scope configuration, troubleshooting, and checking whether a Zoho CRM API change affects the integration.
Portal Link
Sign in to Zoho CRM at https://accounts.zoho.com/signin?servicename=ZohoCRM. Subscribers in another data-center region sign in at the matching regional accounts host — see Base URL below.
Base URL
The integration uses the Zoho CRM REST API, version v2. All endpoint paths below are shown with a [Base URL] prefix; the actual base URL is the Zoho API domain for your organization's data-center region, with /crm appended.
The region is chosen with the Region subscription setting. The US example is https://www.zohoapis.com/crm; other regions use the matching www.zohoapis.<region> domain, which Zoho returns to the integration when the connection is authorized. The OAuth accounts host used to obtain tokens is region-specific in the same way:
Region setting | OAuth accounts host |
zoho.com (US) |
|
zoho.eu (Europe) |
|
zoho.in (India) |
|
zoho.com.au (Australia) |
|
zoho.jp (Japan) |
|
zohocloud.ca (Canada) |
|
zoho.sa (Saudi Arabia) |
|
zoho.uk (UK) |
|
A single production Zoho CRM organization is used per subscription; the integration does not call a separate sandbox host.
Table of Contents
Product Endpoints
Customer Endpoints
Sales Order Endpoints
Custom Field Endpoints
Authorization Endpoint
Product Endpoints
Get All Products (GET)
[Base URL]/v2/products
Retrieves products a page at a time.
Get a Product by Id (GET)
[Base URL]/v2/products/{Id}Get a Product by SKU (GET)
[Base URL]/v2/products/search?criteria=(Product_Code:equals:{Sku})Used when matching an order line's SKU to a Zoho CRM product.
Create a Product (POST)
[Base URL]/v2/products
Update a Product (PUT)
[Base URL]/v2/products/{Id}Customer Endpoints
Customers are held in the Zoho CRM Contacts module.
Get a Customer by Id (GET)
[Base URL]/v2/Contacts/{Id}Poll Customers (GET)
[Base URL]/v2/Contacts?page={Page}Reads contacts a page at a time during a scheduled poll.
Create a Customer (POST)
[Base URL]/v2/Contacts
Update a Customer (PUT)
[Base URL]/v2/Contacts/{Id}Sales Order Endpoints
Get a Sales Order by Id (GET)
[Base URL]/v2/Sales_Orders/{Id}Create a Sales Order (POST)
[Base URL]/v2/Sales_Orders
Update a Sales Order (PUT)
[Base URL]/v2/Sales_Orders/{Id}Custom Field Endpoints
The integration reads a module's field definitions to match mapped custom fields to Zoho CRM fields, and can create custom fields in a module.
Get Module Fields (GET)
[Base URL]/v2/settings/fields?module={Module}{Module} is Contacts, Products, or Sales_Orders.
Create Custom Fields (POST)
[Base URL]/v2/settings/fields?module={Module}Authorization Endpoint
Obtain or Refresh an Access Token (POST)
https://accounts.{region}/oauth/v2/tokenExchanges the authorization code for an access token and refresh token, and later refreshes the access token. The host is the region-specific accounts host shown in the Base URL table above (for example https://accounts.zoho.com/oauth/v2/token for the US region).
Related Documents
External References
Zoho CRM REST API (v2) documentation:
https://www.zoho.com/crm/developer/docs/api/v2/
