Welcome to Zoho CRM API!
Zoho CRM provides API (Application Programming Interface) for integrating CRM modules with any third-party applications such as, accounting, ERP, e-commerce, self-service portals and others. With the Zoho CRM API, you can extract CRM data in XML or JSON format and develop new applications or integrate with your existing business applications. As the Zoho CRM API is independent of programming languages, you can develop applications in any programming language (Java, .Net, C, C++, PHP, etc).
Zoho CRM API can be used to integrate the following types of applications:
- Zoho Services
- Third-party applications
Integration with Zoho Services:
- Zoho Invoice (Available)
- Zoho Mail (Beta Testing)
- Zoho Meeting, Reports, and Creator (Future)
Integration with third-party applications:
- Outlook Plug-in (Available)
- QuickBooks Integration (Beta Testing)
- Online Store Integration
Target Audience
- Developers
- CRM Project Managers
- System Integrators
Prerequisite
- Access to the Zoho CRM service
- Permission to access API service (System-level security settings)
- Developer environment to integrate third-party application
- Internet connection to communicate with Zoho CRM API
Generate API Key
Zoho CRM API service is available for all editions, Free (Single or Three Users), Professional, and Enterprise. You can straight away request for the API Key from your CRM account and the key will be generated on-the-fly without any hassles. Just ensure that you have permission to access the API service.
To generate API key
- Log in to Zoho CRM with Administration privilege.
- Click on the Setup > Admin Settings > Generate API Key link.
Generate Ticket
To generate the ticket ID, send the authenticated request to Zoho Accounts server over a secured connection as given below:
Request
https://accounts.zoho.com/login?servicename=[ZohoCRM]&FROM_AGENT=true&LOGIN_ID=[Zoho Username/Email Address]&PASSWORD=[Password]
The mandatory parameters along with their values to be passed in the URL are:
| Parameter |
Type |
Description |
| servicename |
ZohoCRM |
Specify the service name is ZohoCRM |
| FROM_AGENT |
Boolean |
True |
| LOGIN_ID |
String |
User's Zoho ID or Email ID |
| PASSWORD |
String |
Password for the Zoho ID |
Response
Depending on the parameters passed over the requested URL, you will get a response in the format given below:
| Parameter |
Type |
Description |
| Comment |
String |
Ticket generated date & time |
| GETUSERNAME |
String |
|
| WARNING |
String |
If the parameters passed in the URL are incorrect, the user will get a warning message stating the same otherwise the value will be null. |
| PASS_EXPIRY |
Boolean |
|
| TICKET |
String |
Ticket generated for the request |
| RESULT |
Boolean |
Value is TRUE if the ticket is generated successfully, else it is FALSE. |
CRM Entities
At present, you can use the API methods for integrating the CRM modules listed below:
| Module |
API format |
| Leads |
Leads |
| Accounts |
Accounts |
| Contacts |
Contacts |
| Potentials |
Potentials |
| Campaigns |
Campaigns |
| Tasks |
Tasks |
| Events |
Events |
| Cases |
Cases |
| Solutions |
Solutions |
| Products |
Products |
| Price Books |
PriceBooks |
| Quotes |
Quotes |
| Vendors |
Vendors |
| Purchase Orders |
PurchaseOrders |
| Sales Orders |
SalesOrders |
| Invoices |
Invoices |
Standard Fields
Refer: Zoho CRM - Standard Fields
Custom Fields
Refer: Zoho CRM - Custom Fields
API Methods 
