Organization APIs

This feature enables you to digitally structure your organization. In Zoho One, your company is represented as an Organization. Each organization is assigned with a unique identifier (Organization ID).

You can configure key organizational details using this API, including company name, URL, address, work location, time zone, postal code, and contact information.

End Points

GET

Get all orgs of a user

Fetches the list of all the organizations to which the user belongs.
OAuth Scope : ZohoOne.Orgs.READ

Request Example

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://zohoapis.com/one/api/v2/orgs")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://zohoapis.com/one/api/v2/orgs"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "zohoapis.com",
  "port": null,
  "path": "/one/api/v2/orgs",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

import http.client

conn = http.client.HTTPSConnection("zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/one/api/v2/orgs", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

curl --request GET \
  --url https://zohoapis.com/one/api/v2/orgs \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "status_code": 200,
    "resource_name": "orgs",
    "orgs": [
        {
            "created_time": "2024-xx-14T14:57:42.617+0530",
            "is_active": true,
            "org_id": 1,
            "owner_id": "2xxxxxxxxxxxxxxxx6",
            "display_name": "Zylker"
        },
        {...},
        {...}
    ]
}

{
    "status_code": 401,
    "error_code": "INVALID_TOKEN",
    "message": "Authentication required."
}

{
    "status_code": 403,
    "error_code": "ACCESS_DENIED",
    "message": "You do not have permission to perform this action."
}

Update specific organization's details

Updates the display name of the organization using the given org_id. Display name is mandatory to be given in the parameter to update the organization details.
OAuth Scope : ZohoOne.Orgs.UPDATE

Arguments

display_name

string

Display name of the organization. This is the name given while creating the organization in Zoho One.

Path Parameters

org_id

string

(Required)

ID of the organization

Request Example

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://zohoapis.com/one/api/v2/orgs/1")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://zohoapis.com/one/api/v2/orgs/1"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "zohoapis.com",
  "port": null,
  "path": "/one/api/v2/orgs/1",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

import http.client

conn = http.client.HTTPSConnection("zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/one/api/v2/orgs/1", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

curl --request PUT \
  --url https://zohoapis.com/one/api/v2/orgs/1 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "orgs": {
        "display_name": "Zylker"
    }
}

Response Example

{
    "status_code": 200,
    "resource_name": "orgs",
    "message": "... //Successfully completed",
    "orgs": {
        "org_id": ".....",
        "href": "....."
    }
}

{
    "status_code": 400,
    "error_code": "invalid_field_value",
    "message": "If Null/Empty display_name given"
}

{
    "status_code": 401,
    "error_code": "INVALID_TOKEN",
    "message": "Authentication required."
}

{
    "status_code": 403,
    "error_code": "no_permission",
    "message": "API is accessible to admins only"
}

{
    "status_code": 404,
    "error_code": "RESOURCE_NOT_FOUND",
    "message": "The requested resource was not found."
}

Get specific organization's details

Fetches the details of the specific organization using the given org_id. The organization ID, display name, owner ID, account type, organization created date/time and also the status of the user in the organization will be listed.
OAuth Scope : ZohoOne.Orgs.READ

Path Parameters

org_id

string

(Required)

ID of the organization

Request Example

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://zohoapis.com/one/api/v2/orgs/1")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://zohoapis.com/one/api/v2/orgs/1"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "zohoapis.com",
  "port": null,
  "path": "/one/api/v2/orgs/1",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

import http.client

conn = http.client.HTTPSConnection("zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/one/api/v2/orgs/1", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

curl --request GET \
  --url https://zohoapis.com/one/api/v2/orgs/1 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "status_code": 200,
    "resource_name": "orgs",
    "orgs": {
        "created_time": "2024-xx-14T14:57:42.617+0530",
        "is_active": true,
        "org_id": 1,
        "owner_id": "2xxxxxxxxxxxxxxxx6",
        "display_name": "Zylker"
    }
}

{
    "status_code": 401,
    "error_code": "INVALID_TOKEN",
    "message": "Authentication required."
}

{
    "status_code": 403,
    "error_code": "ACCESS_DENIED",
    "message": "You do not have permission to perform this action."
}

{
    "status_code": 404,
    "error_code": "RESOURCE_NOT_FOUND",
    "message": "The requested resource was not found."
}