Organization API

Purpose

To get the organization data.

Endpoints

Request Details

Request URL

https://www.zohoapis.com/crm/v2/org

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.org.{operation_type}

Possible operation types

ALL - Full access to Organization data
READ - Get Organization data

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v2/org"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
3.0.08.0
Copied//Get instance of OrgOperations Class
OrgOperations orgOperations = new OrgOperations();

//Call getOrganization method
APIResponse < ResponseHandler > response = orgOperations.getOrganization();
Copiedpackage com.zoho.crm.api.sample.restapi.organization;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
public class OrganizationAPI 
{
	public static void main(String[] args) 
	{
		try
		{
			HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
			SSLContext sslContext = SSLContext.getDefault();
			SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
			CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
			URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2/org");
			HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
			requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
			HttpResponse response = httpclient.execute(requestObj);
			HttpEntity responseEntity = response.getEntity();
			System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
			if(responseEntity != null)
			{
				Object responseObject = EntityUtils.toString(responseEntity);
				String responseString = responseObject.toString();
				System.out.println(responseString);
			}
		}
		catch(Exception ex)
		{
			ex.printStackTrace();
		}
	}
}
3.0.07.x
Copied//Get instance of OrgOperations Class
$orgOperations = new OrgOperations();
//Call getNotes method
$response = $orgOperations->getOrganization();
Copied<?php
class GetOrganization{
    
    public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $url = "https://www.zohoapis.com/crm/v2/org";

        $curl_options[CURLOPT_URL] = $url;
        $curl_options[CURLOPT_RETURNTRANSFER] = true;
        $curl_options[CURLOPT_HEADER] = 1;
        $curl_options[CURLOPT_CUSTOMREQUEST] = "GET";
        $headersArray = array();
        
        $headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " ."1000.30f3a5899190XXXXXXXXXXXXXXX.dc5caa18c008d57XXXXXXXXXXXX23";
        $curl_options[CURLOPT_HTTPHEADER]=$headersArray;
        
        curl_setopt_array($curl_pointer, $curl_options);
        
        $result = curl_exec($curl_pointer);
        $responseInfo = curl_getinfo($curl_pointer);
        curl_close($curl_pointer);
        list ($headers, $content) = explode("\r\n\r\n", $result, 2);
        if(strpos($headers," 100 Continue")!==false){
            list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
        }
        $headerArray = (explode("\r\n", $headers, 50));
        $headerMap = array();
        foreach ($headerArray as $key) {
            if (strpos($key, ":") != false) {
                $firstHalf = substr($key, 0, strpos($key, ":"));
                $secondHalf = substr($key, strpos($key, ":") + 1);
                $headerMap[$firstHalf] = trim($secondHalf);
            }
        }
        $jsonResponse = json_decode($content, true);
        if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
            list ($headers, $content) = explode("\r\n\r\n", $content, 2);
            $jsonResponse = json_decode($content, true);
        }
        var_dump($headerMap);
        var_dump($jsonResponse);
        var_dump($responseInfo['http_code']);
        
    }
    
}
(new GetOrganization())->execute();
3.0.08.x
Copied//Get instance of OrgOperations Class
OrgOperations orgOperations = new OrgOperations();            
//Call getOrganization method
APIResponse<ResponseHandler> response = orgOperations.GetOrganization();
Copiedusing System;
using System.IO;
using System.Net;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Organization
{
    public class OrganizationAPI
    {
        public static void GetOrganization()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/org");
            request.Method = "GET";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            request.KeepAlive = true;
            HttpWebResponse response;
            try
            {
                response = (HttpWebResponse)request.GetResponse();
            }
            catch (WebException e)
            {
                if (e.Response == null) { throw; }
                response = (HttpWebResponse)e.Response;
            }
            HttpWebResponse responseEntity = response;
            Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
            string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
            responseEntity.Close();
            Console.WriteLine(responsestring);
        }
    }
}
3.0.0
Copied# Get instance of OrgOperations Class
org_operations = OrgOperations()
# Call get_organization method
response = org_operations.get_organization()
Copieddef get_organization_details():
    import requests

    url = 'https://www.zohoapis.com/crm/v2/org'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
    }

    response = requests.get(url=url, headers=headers)

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

get_organization_details()
1.0.010.x
Copied//Get instance of OrgOperations Class
let orgOperations = new OrgOperations();
//Call getOrganization method
let response = await orgOperations.getOrganization();
Copiedasync function getOrganizationDetails() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2/org'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.354df3680XXXXXXXXXXXXX3.aae0efXXXXXXXXXXXXXXXXXX9"
    }

    let requestDetails = {
        method : "GET",
        headers : headers,
        throwHttpErrors : false
    }
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    }
}
getOrganizationDetails()
2.02.x.x
Copied# Get instance of OrgOperations Class
org_operation = Org::OrgOperations.new
# Call get_organization method
response = org_operation.get_organization
Copiedclass GetOrganization 

    def execute
      
        url = "https://www.zohoapis.com/crm/v2/org"
        url = URI(url)
        req = Net::HTTP::Get.new(url.request_uri)
        http = Net::HTTP.new(url.host, url.port)
        http.use_ssl = true
        headers={}
        headers["Authorization"]="Zoho-oauthtoken 1000.50XXXXXXXXX&77e3a.44XXXXXXXXX8353"
        headers&.each { |key, value| req.add_field(key, value) }
        response=http.request(req)
        status_code = response.code.to_i
        headers = response.each_header.to_h
        print status_code
        print headers
        unless response.body.nil?
            print  response.body
        end
    end
end
GetOrganization.new.execute
1.0.0ES6
Copied//Get instance of OrgOperations Class
let orgOperations = new ZCRM.Org.Operations();
//Call getOrganization method
let response = await orgOperations.getOrganization();
Copiedvar listener = 0;
class OrganizationAPI {

	async getOrganization()	{
		var url = "https://www.zohoapis.com/crm/v2/org"
        var parameters = new Map()
        var headers = new Map()
        var token = {
            clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
            redirectUrl:"http://127.0.0.1:5500/redirect.html",
            scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
        }
        var accesstoken = await new OrganizationAPI().getToken(token)
        headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
        var requestMethod = "GET"
        var reqBody = null
        var params = "";
        parameters.forEach(function(value, key) {
            if (parameters.has(key)) {
                if (params) {
                    params = params + key + '=' + value + '&';
                }
                else {
                    params = key + '=' + value + '&';
                }
            }
        });
        var apiHeaders = {};
        if(headers) {
            headers.forEach(function(value, key) {
                apiHeaders[key] = value;
            });
        }
        if (params.length > 0){
            url = url + '?' + params.substring(0, params.length - 1);
        }
        var requestObj = {
            uri : url,
            method : requestMethod,
            headers : apiHeaders,
            body : JSON.stringify(reqBody),
            encoding: "utf8",
            allowGetBody : true,
			throwHttpErrors : false
        };
        var result = await new OrganizationAPI().makeAPICall(requestObj);
        console.log(result.status)
        console.log(result.response)
	}

    async getToken(token) {

        if(listener == 0) {

            window.addEventListener("storage", function(reponse) {
                if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
                    location.reload();
                }
                if(reponse.key === "access_token"){

                    sessionStorage.removeItem("__auth_process");
                }
            }, false);
            listener = 1;
            if(sessionStorage.getItem("__auth_process")) {
                sessionStorage.removeItem("__auth_process");
            }
        }
        ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
            var isKeyExists = localStorage.hasOwnProperty(k);
            if(isKeyExists) {
                sessionStorage.setItem(k, localStorage[k]);
            }
            localStorage.removeItem(k);
        });
        var valueInStore = sessionStorage.getItem("access_token");
        var tokenInit = sessionStorage.getItem("__token_init");
        if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
            valueInStore = null;
            sessionStorage.removeItem("access_token");
        }

        var auth_process = sessionStorage.getItem("__auth_process");
        if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
            var accountsUrl = "https://accounts.zoho.com/oauth/v2/auth"
            var clientId;
            var scope;
            var redirectUrl;
            if(token != null) {
                clientId = token.clientId;
                scope = token.scope;
                redirectUrl = token.redirectUrl;
            }

            var fullGrant = sessionStorage.getItem("full_grant");
            var grantedForSession = sessionStorage.getItem("granted_for_session");
            if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
                accountsUrl += '/refresh';
            }
            if (clientId && scope) {
                sessionStorage.setItem("__token_init", Date.now());
                sessionStorage.removeItem("access_token");
                sessionStorage.setItem("__auth_process", "true");
                window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
                ["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
                    var isKeyExists = localStorage.hasOwnProperty(k);
                    if(isKeyExists){
                        sessionStorage.setItem(k, localStorage[k]);
                    }
                    localStorage.removeItem(k);
                });
                valueInStore = sessionStorage.getItem("access_token");
            }
        }
        if(token != null && valueInStore != 'undefined'){
            token.accessToken = valueInStore;
        }
        return token.accessToken;
    }

    async makeAPICall(requestDetails) {
        return new Promise(function (resolve, reject) {
            var body, xhr, i;
            body = requestDetails.body || null;
            xhr = new XMLHttpRequest();
            xhr.withCredentials = true;
            xhr.open(requestDetails.method, requestDetails.uri, true);
            for (i in requestDetails.headers) {
                xhr.setRequestHeader(i, requestDetails.headers[i]);
            }
            xhr.send(body);
            xhr.onreadystatechange = function() {
                if(xhr.readyState == 4) {
                    resolve(xhr);
                }
            }
        })
    }
}
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v2/org"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

Response JSON Keys

  • country, city, street, state, zipstring

    Represents the address of the organization.

  • photo_idstring

    Represents the unique ID of the organization photo file. Refer to upload files API for more details.

  • descriptionstring

    Represents the description about the organization, if any.

  • aliasstring

    Represents the alias name of the organization.

  • currencystring

    Represents the base/home currency details of the organization.

  • idstring

    Represents the unique ID of the organization.

  • fax, mobile, primary_email, phonestring

    Represents the contact details of the organization.

  • employee_countstring

    Represents the number of employees in the organization.

  • websitestring

    Represents the website of the organization.

  • currency_symbolstring

    Represents the symbol of the base/home currency specified for the organization. For instance, '₹'.

  • currency_localestring

    Represents the locale of the base/home currency specified for the organization. For instance, 'en_IN'.

  • primary_zuidstring

    Represents ZUID of the organization. This is the ID visible in the profile details in Zoho CRM UI.

  • zia_portal_idstring

    Represents Zia portal ID of the organization, if configured.

  • time_zonestring

    Represents the timezone of the organization.

  • zgidstring

    Represents the unique ZGID of the organization.

  • country_codestring

    Represents the unique code of the country that the organization belongs to. For instance, 'IN'.

  • license_detailsJSON object

    Represents the license details of the organization.

  • company_namestring

    Represents the name of the company in the organization.

  • iso_codestring

    Represents the ISO code of the base/home currency of the organization.

  • privacy_settingsboolean

    Represents if the privacy settings are enabled for the organization.
    Possible values - true: Privacy settings are enabled for the organization.
    false: Privacy settings are disabled for the organization.

  • mc_statusboolean

    Represents if the multi-currency is enabled for the organization.
    Possible values - true: The multi-currency feature is enabled for the organization.
    false: The multi-currency feature is disabled for the organization.

  • gapps_enabledboolean

    Represents if the Google Apps Integration is enabled for the organization.
    Possible values - true: The Google Apps Integration is enabled for the organization.
    false: The Google Apps Integration is disabled for the organization.

  • domain_namestring

    Represents the domain name of the organization. For instance, org694902300.

  • translation_enabledboolean

    Represents if translation is enabled for the organization.
    Possible values - true: Translation is enabled for the organization.
    false: Translation is disabled for the organization.

Possible Errors

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoCRM.org.READ scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to read
    Resolution: The user does not have permission to read records. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in the server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to read organization data
    Resolution: The user does not have the permission to retrieve organization data. Contact your system administrator.

Sample Response

Copied{
  "org": [
    {
      "country": "India",
      "photo_id": "7358375680a0dcf8c26dd5b86af1a28e6cce8d4ec7cba59bd9071012460de963ed4a34822bb8d7d2d49c63c6337195238b5730c7acd93b7eca3e4e90f1702fed",
      "city": "Chennai",
      "description": "This is a sample description.",
      "mc_status": true,
      "gapps_enabled": false,
      "domain_name": "org694902309",
      "translation_enabled": true,
      "street": "GST Road",
      "alias": "sample alias",
      "currency": "Indian Rupee",
      "id": "4150868000000225097",
      "state": "Tamil Nadu",
      "fax": "0987654321",
      "employee_count": "100",
      "zip": "603202",
      "website": "https://www.zylker.com/",
      "currency_symbol": "₹",
      "mobile": "0909090909",
      "currency_locale": "en_IN",
      "primary_zuid": "694579958",
      "zia_portal_id": "710883907",
      "time_zone": "Asia/Calcutta",
      "zgid": "694902309",
      "country_code": "IN",
      "license_details": {
        "paid_expiry": "2020-09-20T05:30:00+05:30",
        "users_license_purchased": 5,
        "trial_type": null,
        "trial_expiry": null,
        "paid": true,
        "paid_type": "enterprise"
      },
      "phone": "04467447070",
      "company_name": "Zylker",
      "privacy_settings": true,
      "primary_email": "patricia.b@zohocorp.com",
      "iso_code": "INR"
    }
  ]
}