Zoho: Org schemas

← Org operations · All schemas

Get organization details — response body — org / item / type: bigin, production, sandbox, developer

Field	Type	Presence	Description and constraints
$	object	Root	Represents the organization details for the Zoho CRM account, including company information, currency settings, license details, and hierarchy preferences. Additional keys: not allowed
alias	JSON	Optional	Represents the alias name of the organization.
alias (anyOf 1)	string	Alternative	Represents the alias of the organization when one is set. Maximum length: 50
alias (anyOf 2)	null	Alternative	Represents a null value when no alias is set for the organization.
city	JSON	Optional	Represents the city where the organization is located.
city (anyOf 1)	string	Alternative	Represents the city where the organization is located when a value is available. Maximum length: 50
city (anyOf 2)	null	Alternative	Represents a null value when no city is set for the organization.
company_name	JSON	Optional	Represents the name of the organization.
company_name (anyOf 1)	string	Alternative	Represents the name of the organization when one is set. Maximum length: 100
company_name (anyOf 2)	null	Alternative	Represents a null value when the company name has not been set. Read only: true
country	JSON	Optional	Represents the country of the organization.
country (anyOf 1)	string	Alternative	Represents the country of the organization when a value is available. Maximum length: 50
country (anyOf 2)	null	Alternative	Represents a null value when no country is set for the organization.
country_code	JSON	Optional	Represents the country code of the organization.
country_code (anyOf 1)	string	Alternative	Represents the country code of the organization when a value is available. Maximum length: 10
country_code (anyOf 2)	null	Alternative	Represents a null value when no country code is set for the organization.
created_time	string	Optional	Represents the creation date and time of the organization. Format: date-time Read only: true
currency	string	Optional	Represents the home currency of the organization. Maximum length: 30
currency_locale	string	Optional	Represents the locale code for the organization's home currency. For instance, 'en_IN'. Maximum length: 10
currency_symbol	string	Optional	Represents the currency symbol for the organization's home currency. Maximum length: 5 Minimum length: 1
deletable_org_account	boolean	Optional	Indicates whether the organization account can be deleted. Possible values: **true** - The organization can be deleted. **false** - The organization cannot be deleted. Read only: true
description	JSON	Optional	Represents the description of the organization.
description (anyOf 1)	string	Alternative	Represents the description of the organization when one is provided. Maximum length: 250
description (anyOf 2)	null	Alternative	Represents a null value when no description is set for the organization.
domain_name	string	Optional	Represents the domain name of the organization. For instance, org694902300. Maximum length: 30 Pattern: [a-z][a-z0-9]{4,30}
employee_count	JSON	Optional	Represents the number of employees in the organization.
employee_count (anyOf 1)	string	Alternative	Represents the number of employees in the organization when a value is available. Maximum length: 18 Pattern: [0-9]+
employee_count (anyOf 2)	null	Alternative	Represents a null value when no employee count is set for the organization.
fax	JSON	Optional	Represents the fax number of the organization.
fax (anyOf 1)	string	Alternative	Represents the fax number of the organization when one is provided. Maximum length: 30
fax (anyOf 2)	null	Alternative	Represents a null value when no fax number is set for the organization.
gapps_enabled	boolean	Optional	Indicates whether Google Apps integration is enabled for the organization. Possible values: **true** - Google Apps integration is enabled. **false** - Google Apps integration is not enabled. Read only: true
hierarchy_preferences	object	Optional	Represents the hierarchy preferences configured for the organization. Additional keys: not allowed
hierarchy_preferences.strictly_reporting	JSON	Optional
hierarchy_preferences.strictly_reporting (anyOf 1)	boolean	Alternative	Indicates whether data visibility is restricted to the direct reporting chain. Possible values: **true** - Data is visible only to the CEO and administrators. **false** - Data is visible to any user higher in the hierarchy.
hierarchy_preferences.strictly_reporting (anyOf 2)	null	Alternative	Indicates whether data visibility is restricted to the direct reporting chain. Possible values: **true** - Data is visible only to the CEO and administrators. **false** - Data is visible to any user higher in the hierarchy.
hierarchy_preferences.type	string	Required within parent	Represents the hierarchy type configured for the organization. Possible values: **Role_Hierarchy** - Access is based on the user's role in the hierarchy. **Reporting_To_Hierarchy** - Access is based on the user's reporting structure. Known values: Role_Hierarchy, Reporting_To_Hierarchy
hipaa_compliance_enabled	boolean	Optional	Indicates whether [HIPAA compliance](https://www.zoho.com/crm/developer/docs/api/v8/hipaa-compliance.html) is enabled for the organization. Possible values: **true** - HIPAA compliance is enabled. **false** - HIPAA compliance is not enabled. Read only: true
id	string	Optional	Represents the unique ID of the organization. Maximum length: 19 Read only: true
iso_code	string	Optional	Represents the ISO code of the organization's home currency. Maximum length: 10
license_details	object	Optional	Represents the license and subscription details for the organization. Read only: true Additional keys: not allowed
license_details.paid	boolean	Required within parent	Indicates whether the organization has a paid subscription. Possible values: **true** - The organization has a paid subscription. **false** - The organization does not have a paid subscription. Read only: true
license_details.paid_expiry	JSON	Optional	Represents the expiry date of the paid license for the organization. Read only: true
license_details.paid_expiry (anyOf 1)	string	Alternative	Represents the license details variant. Format: date-time
license_details.paid_expiry (anyOf 2)	null	Alternative	Represents the license details variant.
license_details.paid_type	string	Required within parent	Represents the license type for the organization. Possible values: **free** - Free edition. **standard** - Standard edition. **professional** - Professional edition. **enterprise** - Enterprise edition. **ultimate** - Ultimate edition. **crmplus** - CRM Plus edition. **zohoone** - Zoho One edition. Known values: free, standard, professional, enterprise, ultimate, crmplus, zohoone Read only: true
license_details.portal_users_license_purchased	JSON	Required within parent
license_details.portal_users_license_purchased (anyOf 1)	integer	Alternative	Represents the number of portal user licenses purchased for the organization. Format: int32 Read only: true
license_details.portal_users_license_purchased (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
license_details.trial_expiry	JSON	Optional	Represents the expiry date of the trial subscription for the organization.
license_details.trial_expiry (anyOf 1)	string	Alternative	Represents the license details variant. Format: date-time
license_details.trial_expiry (anyOf 2)	null	Alternative	Represents the license details variant.
license_details.trial_type	JSON	Optional	Represents the type of trial subscription for the organization. Read only: true
license_details.trial_type (anyOf 1)	string	Alternative	Represents the license details variant. Maximum length: 50
license_details.trial_type (anyOf 2)	null	Alternative	Represents the license details variant.
license_details.users_license_purchased	JSON	Required within parent
license_details.users_license_purchased (anyOf 1)	integer	Alternative	Represents the number of user licenses purchased for the organization. Format: int32 Read only: true
license_details.users_license_purchased (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
lite_users_enabled	boolean	Optional	Indicates whether lite users are enabled for the organization. Possible values: **true** - Lite users are enabled. **false** - Lite users are not enabled. Read only: false
mc_status	JSON	Optional
mc_status (anyOf 1)	boolean	Alternative	Indicates the multi-currency status of the organization. Possible values: **true** - Multi-currency is enabled. **false** - Multi-currency is not enabled. Read only: true
mc_status (anyOf 2)	null	Alternative	Indicates the multi-currency status of the organization. Possible values: **true** - Multi-currency is enabled. **false** - Multi-currency is not enabled. Read only: true
mobile	JSON	Optional	Represents the mobile phone number of the organization.
mobile (anyOf 1)	string	Alternative	Represents the mobile phone number of the organization when one is provided. Maximum length: 30 Pattern: ^[+]?([0-9A-Za-z()\.\-\s]){1,30}$
mobile (anyOf 2)	null	Alternative	Represents a null value when no mobile number is set for the organization.
phone	JSON	Optional	Represents the primary phone number of the organization.
phone (anyOf 1)	string	Alternative	Represents the phone number of the organization when one is provided. Maximum length: 30 Pattern: ^[+]?([0-9A-Za-z()\.\-\s]){1,30}$
phone (anyOf 2)	null	Alternative	Represents a null value when no phone number is set for the organization.
photo_id	JSON	Optional	Represents the photo ID of the organization's logo. Refer to [upload files API](https://www.zoho.com/crm/developer/docs/api/v8/upload-files-to-zfs.html) for more details. Read only: true
photo_id (anyOf 1)	string	Alternative	Represents the photo ID of the organization's logo when one is available. Refer to the [POST - Upload Files to Zoho File System (ZFS) API](files.yaml#$.path./files.post) for more details. Maximum length: 50
photo_id (anyOf 2)	null	Alternative	Represents a null value when no logo is set for the organization.
primary_email	JSON	Optional	Represents the email address of the super admin of the organization.
primary_email (anyOf 1)	string	Alternative	Represents the email address of the super admin when one is assigned to the organization. Maximum length: 100
primary_email (anyOf 2)	null	Alternative	Represents a null value when no super admin is assigned to the organization.
primary_zuid	JSON	Optional	Represents ZUID of the organization. This is the ID visible in the profile details in Zoho CRM UI.
primary_zuid (anyOf 1)	string	Alternative	Represents the Zoho user ID (ZUID) of the super admin when one is assigned. Maximum length: 19
primary_zuid (anyOf 2)	null	Alternative	Represents a null value when no super admin is assigned to the organization. Read only: true
privacy_settings	boolean	Optional	Indicates whether privacy settings are enabled for the organization. Possible values: **true** - Privacy settings are enabled. **false** - Privacy settings are not enabled. Read only: true
state	JSON	Optional	Represents the state or province where the organization is located.
state (anyOf 1)	string	Alternative	Represents the state or province of the organization when a value is available. Maximum length: 50
state (anyOf 2)	null	Alternative	Represents a null value when no state is set for the organization.
street	JSON	Optional	Represents the street address of the organization.
street (anyOf 1)	string	Alternative	Represents the street address of the organization when one is provided. Maximum length: 50
street (anyOf 2)	null	Alternative	Represents a null value when no street address is set for the organization.
time_zone	string	Optional	Represents the time zone configured for the organization. Maximum length: 30
translation_enabled	boolean	Optional	Indicates whether translation is enabled for the organization. Possible values: **true** - Translation is enabled. **false** - Translation is not enabled. Read only: true
type	string	Optional	Represents the type of the Zoho CRM organization. Possible values: **bigin** - Bigin organization. **production** - Standard production CRM organization. **sandbox** - Sandbox organization for testing. **developer** - Developer organization. Known values: bigin, production, sandbox, developer Read only: true
website	JSON	Optional	Represents the website URL of the organization.
website (anyOf 1)	string	Alternative	Represents the website URL of the organization when one is provided. Maximum length: 50
website (anyOf 2)	null	Alternative	Represents a null value when no website is set for the organization.
zgid	string	Optional	Represents the unique Zoho Group ID (ZGID) of the organization. Maximum length: 19 Read only: true
zia_portal_id	JSON	Optional	Represents Zia portal ID of the organization, if configured. Read only: true
zia_portal_id (anyOf 1)	JSON	Alternative
zia_portal_id (anyOf 1) (anyOf 1)	integer	Alternative	Represents the Zia portal ID associated with the organization when one exists. Format: int32
zia_portal_id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
zia_portal_id (anyOf 2)	null	Alternative	Represents a null value when no Zia portal is associated with the organization.
zip	JSON	Optional	Represents the postal code of the organization.
zip (anyOf 1)	string	Alternative	Represents the postal code of the organization when one is provided. Maximum length: 20
zip (anyOf 2)	null	Alternative	Represents a null value when no postal code is set for the organization.