{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zoho/main/json-schema/zoho-org-details-schema.json",
  "title": "OrgDetails",
  "description": "Company details",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/zoho-org-api-openapi.yml#/components/schemas/OrgDetails",
  "type": "object",
  "properties": {
    "country": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 50,
          "description": "value present"
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "Company's country"
    },
    "photo_id": {
      "readOnly": true,
      "oneOf": [
        {
          "type": "string",
          "description": "photo present",
          "maxLength": 50
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "photo id of the company's logo"
    },
    "city": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 50,
          "description": "value present"
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "Company's city"
    },
    "description": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 250,
          "description": "value present"
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "description"
    },
    "type": {
      "type": "string",
      "enum": [
        "bigin",
        "production",
        "sandbox",
        "developer"
      ],
      "description": "type of org",
      "readOnly": true
    },
    "created_time": {
      "type": "string",
      "format": "date-time",
      "description": "time of creation",
      "readOnly": true
    },
    "mc_status": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "multi currency status",
      "readOnly": true
    },
    "gapps_enabled": {
      "type": "boolean",
      "description": "google apps integration status",
      "readOnly": true
    },
    "translation_enabled": {
      "type": "boolean",
      "description": "translation status",
      "readOnly": true
    },
    "street": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 50,
          "description": "value present"
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "Company's street"
    },
    "domain_name": {
      "type": "string",
      "pattern": "[a-z][a-z0-9]{4,30}",
      "maxLength": 30,
      "description": "domain name of the organization"
    },
    "alias": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 50,
          "description": "value present"
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "Company's alias"
    },
    "currency": {
      "type": "string",
      "description": "home currency",
      "maxLength": 30
    },
    "id": {
      "type": "string",
      "description": "org id",
      "maxLength": 20,
      "readOnly": true
    },
    "employee_count": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 18,
          "pattern": "[0-9]+",
          "description": "value present"
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "Company's employee count"
    },
    "state": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 50,
          "description": "state"
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "Company's state"
    },
    "fax": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 30,
          "description": "value present"
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "Company's fax"
    },
    "zip": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 20,
          "description": "value present"
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "Company's postal code"
    },
    "website": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 50,
          "pattern": "^(http:\\/\\/www.|https:\\/\\/www.|ftp:\\/\\/www.|www.|http:\\/\\/|https:\\/\\/|ftp:\\/\\/|){1}[^\\x00-\\x19\\x22-\\x27\\x2A-\\x2C\\x2E-\\x2F\\x3A-\\x3F\\x5B-\\x5E\\x60\\x7B\\x7D-\\x7F]+(\\.[^\\x00-\\x19\\x22\\x24-\\x2C\\x2E-\\x2F\\x3C\\x3E\\x40\\x5B-\\x5E\\x60\\x7B\\x7D-\\x7F]+)+([\\/\\?].*)*$",
          "description": "value present"
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "Company's website"
    },
    "currency_symbol": {
      "type": "string",
      "maxLength": 5,
      "minLength": 1,
      "description": "home currency symbol"
    },
    "mobile": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 30,
          "pattern": "^[+]?([0-9A-Za-z()\\.\\-\\s]){1,30}$",
          "description": "value present"
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "Company's mobile"
    },
    "currency_locale": {
      "type": "string",
      "maxLength": 10,
      "description": "home currency locale"
    },
    "primary_zuid": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 20,
          "description": "zuid of the super admin"
        },
        {
          "type": "null",
          "description": "null value if there is no super admin(only when company details not updated)",
          "readOnly": true
        }
      ]
    },
    "zia_portal_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "zia portal id",
      "readOnly": true
    },
    "time_zone": {
      "type": "string",
      "maxLength": 30,
      "description": "Company's time zone"
    },
    "zgid": {
      "type": "string",
      "description": "zgid",
      "maxLength": 20,
      "readOnly": true
    },
    "country_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "Company's country code"
    },
    "deletable_org_account": {
      "type": "boolean",
      "description": "is deletable",
      "readOnly": true
    },
    "license_details": {
      "type": "object",
      "readOnly": true,
      "description": "license details",
      "properties": {
        "paid_expiry": {
          "oneOf": [
            {
              "type": "string",
              "format": "date-time",
              "description": "value present"
            },
            {
              "type": "null",
              "description": "null value"
            }
          ],
          "readOnly": true,
          "description": "license expiry date"
        },
        "users_license_purchased": {
          "type": "integer",
          "format": "int32",
          "readOnly": true,
          "description": "no of users can be added based on the purchased licenses"
        },
        "trial_type": {
          "type": [
            "string",
            "null"
          ],
          "description": "trial type",
          "readOnly": true
        },
        "trial_expiry": {
          "type": [
            "string",
            "null"
          ],
          "description": "trial expiry date"
        },
        "paid": {
          "type": "boolean",
          "description": "is paid edition account",
          "readOnly": true
        },
        "paid_type": {
          "type": "string",
          "readOnly": true,
          "description": "actual license type",
          "enum": [
            "free",
            "standard",
            "professional",
            "enterprise",
            "ultimate",
            "crmplus",
            "crmplusstarter",
            "zohooneenterprise",
            "zohoonestandard"
          ]
        },
        "portal_users_license_purchased": {
          "type": "integer",
          "format": "int32",
          "description": "no of portal users can be added based on the purchased licenses",
          "readOnly": true
        }
      },
      "additionalProperties": false,
      "required": [
        "users_license_purchased",
        "paid",
        "paid_type",
        "portal_users_license_purchased"
      ]
    },
    "hierarchy_preferences": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Role_Hierarchy",
            "Reporting_To_Hierarchy"
          ],
          "description": "type of hierarchy"
        },
        "strictly_reporting": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "non reporting users data should be visible to CEO and Administator(true) or any user higher in the hierarchy(false)"
        }
      },
      "required": [
        "type"
      ],
      "additionalProperties": false,
      "description": "hierarchy preference of an organization"
    },
    "phone": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 30,
          "pattern": "^[+]?([0-9A-Za-z()\\.\\-\\s]){1,30}$",
          "description": "phone number present"
        },
        {
          "type": "null",
          "description": "null value"
        }
      ],
      "description": "Company's phone number"
    },
    "company_name": {
      "oneOf": [
        {
          "type": "string",
          "maxLength": 100,
          "description": "Company name present"
        },
        {
          "type": "null",
          "description": "null value.",
          "readOnly": true
        }
      ],
      "description": "Company's name"
    },
    "privacy_settings": {
      "type": "boolean",
      "description": "privacy settings enabled status",
      "readOnly": true
    },
    "primary_email": {
      "oneOf": [
        {
          "type": "string",
          "pattern": "^[\\+\\-\\p{L}\\p{M}\\p{N}_]([\\p{L}\\p{M}\\p{N}!#$%&'*+\\-\\/=?^_`{|}~.]*)@(?=.{4,256}$)(([\\p{L}\\p{N}\\p{M}]+)(([\\-_]*[\\p{L}\\p{M}\\p{N}])*)[.])+[\\p{L}\\p{M}]{2,22}$",
          "description": "super admin present",
          "maxLength": 100
        },
        {
          "type": "null",
          "description": "null value if there is no super admin(only when company details not updated)"
        }
      ],
      "description": "Email of the super admin"
    },
    "iso_code": {
      "type": "string",
      "maxLength": 10,
      "description": "iso code of the home currency"
    },
    "hipaa_compliance_enabled": {
      "type": "boolean",
      "description": "hipaa compliances enabled status",
      "readOnly": true
    },
    "lite_users_enabled": {
      "type": "boolean",
      "description": "lite users enabled status",
      "readOnly": true
    }
  },
  "additionalProperties": false
}