Organization API

Purpose

To get the organization data.

Endpoints

GET /org

Request Details

Request URL

https://www.zohoapis.com/bigin/v1/org

Scope

scope=ZohoBigin.org.{operation_type}

Possible operation types

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

Sample Request

Copiedcurl "https://www.zohoapis.com/bigin/v1/org"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

CopiedZBiginRestClient client = ZBiginRestClient.getInstance();
APIResponse response = client.getOrganizationDetails();
ZBiginOrganization org = (ZBiginOrganization) response.getData();

Copiedtry{
          $restIns=ZBiginRestClient::getInstance();
          $res=$restIns->getOrganizationDetails();
          $orgIns=$res->getData();
          echo $orgIns->getCompanyName();
          echo $orgIns->getOrgId();
          echo $orgIns->getCountryCode();
          echo $orgIns->getCountry();
          echo $orgIns->getCurrencyLocale();
          echo $orgIns->getFax();
          echo $orgIns->getAlias();
          echo $orgIns->getDescription();
          echo $orgIns->getStreet();
          echo $orgIns->getCity();
          echo $orgIns->getState();
          echo $orgIns->getZgid();
          echo $orgIns->getWebSite();
          echo $orgIns->getPrimaryEmail();
          echo $orgIns->getPrimaryZuid();
          echo $orgIns->getIsoCode();
          echo $orgIns->getPhone();
          echo $orgIns->getMobile();
          echo $orgIns->getEmployeeCount();
          echo $orgIns->getCurrencySymbol();
          echo $orgIns->getTimeZone();
          echo $orgIns->getMcStatus();
          echo $orgIns->isGappsEnabled();
          echo $orgIns->isPaidAccount();
          echo $orgIns->getPaidExpiry();
          echo $orgIns->getPaidType();
          echo $orgIns->getTrialType();
          echo $orgIns->getTrialExpiry();
          echo $orgIns->getZipCode();
          }
          catch (ZBiginException $e)
          {
          echo $e->getCode();
          echo $e->getExceptionDetails();
          echo $e->getMessage();
          echo $e->getTraceAsString();
          }

Copieddef get_org_details(self):
        try:
            resp =ZBiginRestClient.get_instance().get_organization_details()
            print (resp.status_code)
            org_ins = resp.data
            print (org_ins)
            print (org_ins.company_name)
            print (org_ins.org_id)
            print (org_ins.alias)
            print (org_ins.primary_zuid)
            print (org_ins.zgid)
            print (org_ins.primary_email)
            print (org_ins.website)
            print (org_ins.mobile)
            print (org_ins.phone)
            print (org_ins.employee_count)
            print (org_ins.description)
            print (org_ins.time_zone)
            print (org_ins.iso_code)
            print (org_ins.currency_locale)
            print (org_ins.currency_symbol)
            print (org_ins.street)
            print (org_ins.state)
            print (org_ins.city)
            print (org_ins.country)
            print (org_ins.zip_code)
            print (org_ins.country_code)
            print (org_ins.fax)
            print (org_ins.mc_status)
            print (org_ins.is_gapps_enabled)
            print (org_ins.paid_expiry)
            print (org_ins.trial_type)
            print (org_ins.trial_expiry)
            print (org_ins.is_paid_account)
            print (org_ins.paid_type)
        except ZBiginException as ex:
            print (ex.status_code)
            print (ex.error_message)
            print (ex.error_code)
            print (ex.error_details)
            print (ex.error_content)

CopiedZBiginRestClient restClient = ZBiginRestClient.GetInstance();
APIResponse response = restClient.GetOrganizationDetails();
ZBiginOrganization organization = (ZBiginOrganization)response.Data;

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v1/org"
	type: GET
	connection:"bigin_oauth_connection"
];
info response;

Response JSON Keys

iso code
String representing base currency of the current org.

Sample Response

Copied{
  "org": [
    {
      "country": "India",
      "photo_id": "7358375680a0dcf8c26dd5b86af1a28e6cce8d4ec7cba59bd9071012460de963ed4a34822bb8d7d2d49c63c6337195238b5730c7acd93b7eca3e4e90f1702fed",
      "city": "Chennai",
      "description": "This is a sample description.",
      "gapps_enabled": false,
      "domain_name": "org694902309",
      "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",
      "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": "bigin"
      },
      "phone": "04467447070",
      "company_name": "Zylker",
      "privacy_settings": true,
      "primary_email": "patricia.b@zohocorp.com",
      "iso_code": "INR"
    }
  ]
}