API Docs
/
No Results Found
Introduction

Introduction

The Zoho Directory API allows you to perform all the operations that you do with our web client.

Zoho Directory API is built using REST principles which ensures predictable URLs that makes writing applications easy. This API follows HTTP rules, enabling a wide range of HTTP clients can be used to interact with the API.

Every resource is exposed as a URL. The URL of each resource can be obtained by accessing the API Root Endpoint.

API Root Endpoint

Click to copy
https://zohoapis.com/directory/api/v2

Organization ID

In Zoho Directory, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Directory Organization with it’s own organization ID, base currency, time zone, language, contacts, reports, etc.

The parameter organization_id along with the organization ID should be sent in with every API request to identify the organization.

The organization_id can be obtained from the GET /orgs API’s JSON response.
oauthscope : ZohoDirectory.orgs.READ

Request Example

Click to copy
$ curl https://zohoapis.com/directory/api/v2/orgs -H 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "status_code": 200, "modified_time": 0, "orgs": [{ "is_active": true, "org_id": "9xxxxxx4", "owner_id": "2xxxxxxxxxxxxxxxx6", "display_name": "Zylker", "created_time": "2025-01-22T15:41:32.487+0530" }, {...}, {...} ], "resource_name": "orgs" }

Multiple Data Centers

Zoho Directory is hosted at multiple data centers, and therefore available on different domains.

There are 8 different domains for Zoho Directory' APIs, and you will have to use the one that is applicable to you.

Data Center Domain Base API URI
United States .com https://zohoapis.com/
Europe .eu https://zohoapis.eu/
India .in https://zohoapis.in/
Australia .com.au https://zohoapis.com.au/
Japan .jp https://zohoapis.jp/
Canada .ca https://zohoapis.ca/
China .com.cn https://zohoapis.com.cn/
Saudi Arabia .sa https://zohoapis.sa/

The APIs on this page are for organizations in Zoho Directory that are hosted on the .com domain. If your organization is on a different domain, then you must replace .com with the appropriate domain for API endpoints on this page before using them.

Note: To know the domain you're accessing Zoho Directory from, check your organization's API base URL domain. If the URL contains zohoapis.com, then you're on the .com domain. If it contains zohoapis.in, you're on the .in domain. Similarly, you could be on the .eu or .com.au or .jp or .ca domain.


For example, here's how you would modify the domain in an API endpoint for the .eu domain:

API endpoint for the .com domain, as available on this page:

https://zohoapis.com/directory/api/v2/orgs

API endpoint after replacing the .com domain with .eu:

https://zohoapis.eu/directory/api/v2/orgs