Organization

Overview

An organization in Bigin represents a company that consists of key information such as currency, time zone, company logo, access URL and so on.

Endpoints

GET /org

Get organization details

Retrieves the details of the organization.

Request URL

{api-domain}/bigin/v2/org

Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

For US, https://www.zohoapis.com
For EU, https://www.zohoapis.eu
For AU, https://www.zohoapis.com.au
For IN, https://www.zohoapis.in
For CN, https://www.zohoapis.com.cn
For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

Authorization

For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with one of the following scopes:

ZohoBigin.org.ALL
ZohoBigin.org.READ

Request parameters

The request parameters aren't available for this endpoint.

Sample request

Curl Deluge

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

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

Response object

The response object contains the following details:

country, city, street, state, zip string

Indicates the address of the organization.

country - the name of the country
city - the name of the city
street - the name of the street
state - the name of the state
zip - the postal code of the region

hierarchy_preferences jsonobject

Contains the preferences settings for the organization's hierarchy structure.

photo_id string

Indicates the unique identification of the organization's profile photo. For more information, see Upload organization photo.

description string

Indicates the description of the organization. The description is shown only if it is available, else null is displayed.

mc_status boolean

Has the value true if the user enables the multi-currency feature for the organization or the value false if the user disables the multi-currency feature for the organization.

gapps_enabled boolean

Has the value true if the user enables Google Apps Integration for the organization or the value false if the user disables Google Apps Integration for the organization.

lite_users_enabled boolean

Has the value true if the lite users are enabled for the organization or the value false if the lite users are not enabled for the organization.

domain_name string

Indicates the domain name of the organization.

translation_enabled boolean

Has the value true if the user enables the translation for the organization or the value false if the user disables the translation for the organization.

alias string

Indicates the alias name of the organization.

currency string

Indicates the base or home currency details of the organization.

deletable_org_account boolean

Has the value true if the organization's account is deletable or the value false if the organization's account is not deletable.

id string

Indicates the unique identification of the organization.

fax, mobile, phone, primary_email string

Indicates the contact details of the organization.

fax - the fax number of the organization
mobile - the mobile number of the organization
phone - the phone number of the organization
primary_email - the primary email address of the organization

employee_count integer

Indicates the count of employees in the organization.

website string

Indicates the website of the organization.

currency_symbol string

Indicates the symbol of the base or home currency which is specified in the organization.

currency_locale string

Indicates the locale of the base or home currency which is specified in the organization.

primary_zuid string

Indicates the zoho's unique identification of the primary user in the organization.

zia_portal_id string

Indicates the unique identification of Zia Portal for the organization. This is available only if Zia Portal is configured in the organization.

time_zone string

Indicates the timezone of the organization.

zgid string

Indicates Zoho's unique identification of the organization.

country_code string

Indicates the unique code of the country to which the organization is belonged.

license_details jsonobject

The JSON object contains the license details of the organization.

paid_expiry string

Indicates the expiry date and time of the license.

users_license_purchased integer

Indicates the count of users for whom the license is purchased.

trial_type string

Indicates the trial type the organization is belonged.

trial_expiry string

Indicates the expiry date and time of the trial license.

paid boolean

Has the value true if you are using paid version of the application or the value false if you are using trial version of the application.

paid_type string

Indicates the paid type of the license. For example, Basic, Express or Premier.

company_name string

Indicates the name of the company specified in the organization.

privacy_settings boolean

Has the value true if the user enables the privacy settings of the organization or the value false if the user disables the privacy settings of the organization.

hipaa_compliance_enabled boolean

Has the value true if the user enables the HIPAA Compliance settings of the organization or the value false if the user disables the HIPAA Compliance settings of the organization.

iso_code string

Indicates the ISO code of base or home currency which is specified in the organization.

Possible error codes

The response of this resource includes HTTP status and error codes.

Sample response

Copied{
    "org": [
        {
            "country": "United States",
            "hierarchy_preferences": {
                "type": "Role_Hierarchy"
            },
            "photo_id": "872175758e70545d3e5dcaxxxxbacc0fc9f30dcadbbeb4e4dd0c233701b6d361a6b72xxxx",
            "city": "Anytown",
            "description": "Zylker Travels is a full-service travel agency that specializes in creating unforgettable vacation experiences for our clients",
            "mc_status": false,
            "gapps_enabled": false,
            "lite_users_enabled": false,
            "domain_name": "org75407139",
            "translation_enabled": false,
            "street": "123 Main Street",
            "alias": null,
            "currency": "US Dollar",
            "deletable_org_account": false,
            "id": "2034020000000013208",
            "state": "NY",
            "fax": "+1 (123) 456-7899",
            "employee_count": null,
            "zip": "12345",
            "website": "www.ztsample.com",
            "currency_symbol": "$",
            "mobile": "+1 (987) 654-3210",
            "currency_locale": "USD",
            "primary_zuid": "75407535",
            "zia_portal_id": null,
            "time_zone": "Asia/Kolkata",
            "zgid": "75407139",
            "country_code": "US",
            "license_details": {
                "paid_expiry": "2024-04-11T05:30:00+05:30",
                "users_license_purchased": 5,
                "trial_type": null,
                "trial_expiry": null,
                "paid": true,
                "paid_type": "biginpremier"
            },
            "phone": "+1 (123) 456-7890",
            "company_name": "Zylker Travels",
            "privacy_settings": false,
            "primary_email": "xxxxx.xxxxx@xxx.com",
            "hipaa_compliance_enabled": false,
            "iso_code": "USD"
        }
    ]
}