Zoho Cliq REST API Documentation
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Zoho Cliq's REST API is built on RESTful architecture principles, enabling seamless communication between your applications and the Zoho Cliq platform. Our API leverages standard HTTP protocols, making integration straightforward and intuitive for developers.
API Root Endpoint- The Zoho Cliq API is based on REST principles. It enables you to perform read-and-write operations similar to those available with our web client.
- The relative path prefix
/v2/indicates that we currently use version 2 of our API. This API adheres to HTTP standards, identifies Cliq users through OAuth, and responds to JSON objects. - Each resource URL serves as a unique identifier, and you can access the URL for each resource by navigating to the API Root Endpoint.
https://cliq.zoho.com/api/v2
Authentication
Zoho Cliq API uses the OAuth 2.0 protocol for authentication. OAuth 2.0 is an industry-standard protocol specification that enables third-party applications (also known as clients) to gain delegated access to protected resources in Zoho Cliq via an API.
What is OAuth 2.0?OAuth 2.0 is an industry-standard protocol that allows you to grant a third-party website or application (i.e., a client) delegated access to Zoho Cliq's protected resources via Zoho Cliq APIs. It is a way to authenticate and authorise API requests made to Zoho Cliq.
Advantages of OAuth 2.0- Clients are not required to support password authentication or store user credentials, as authentication and authorisation are handled by exchanging OAuth tokens.
- Clients gain delegated access, i.e., access only to resources authorised by the user.
- Users can revoke a third-party application's delegated access at any time.
- OAuth access tokens expire after a set time. If the client faces a security breach, user data will be compromised only as long as the access token remains valid.
Networks
Cliq network is a dedicated space for collaborating with external business stakeholders such as partners, vendors, agencies, consultants, volunteers, and more. It equips you with an extensive set of configurable permissions to facilitate controlled, secure, and full-fledged external collaboration.
In the case of networks, the API Root endpoint differs. All the network endpoints should have the prefix as /network/{NETWORK_UNIQUE_NAME} or /network/{NETWORK_ID}
For example, the API Root endpoints to call information from a Cliq network named 'Zylker Clients' would be:
https://cliq.zoho.com/network/zylkerclients
zylkerclients is the unique name of the network.
https://cliq.zoho.com/network/{NETWORK_UNIQUE_NAME}
https://cliq.zoho.com/network/{NETWORK_ID}
Multiple Data Centers
Zoho Cliq is hosted at multiple data centers, and therefore available on different domains.
There are 9 different domains for Zoho Cliq's APIs, so you can use the one that is applicable to you.
| Data Center | Domain | Base API URI |
|---|---|---|
| United States | .com | https://cliq.zoho.com/ |
| Europe | .eu | https://cliq.zoho.eu/ |
| India | .in | https://cliq.zoho.in/ |
| Australia | .au | https://cliq.zoho.com.au/ |
| China | .cn | https://cliq.zoho.com.cn/ |
| Japan | .jp | https://cliq.zoho.jp/ |
| Saudi Arabia | .sa | https://cliq.zoho.sa/ |
| United Kingdom | .uk | https://cliq.zoho.uk/ |
| Canada | .zohocloud.ca | https://cliq.zohocloud.ca/ |
The APIs on this page are for organizations hosted on the .com domain. If your organization is on a different domain, replace ".com" with the appropriate domain for the API endpoints on this page before using them.