> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Zoho CRM: README
> Get Organization data. Zoho CRM Org Get Organization reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.
Get Organization data.
Tool ID: `zoho_crm_org_get_organization`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoho_crm_org_get_organization',
{},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_org_get_organization --input '{}' --json
```
## Example response
The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_org_get_organization --json` for the complete live contract.
## Input reference
To get the Company Details
This action does not require input fields.
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "To get the Company Details",
"properties": {},
"required": [],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | JSON Response |
| `result.data.org` | `array` | Yes | — | array of organization details Maximum items: 1. |
| `result.data.org[].country` | `record` | No | — | Company's country |
| `result.data.org[].photo_id` | `record` | No | — | photo id of the company's logo |
| `result.data.org[].city` | `record` | No | — | Company's city |
| `result.data.org[].description` | `record` | No | — | description |
| `result.data.org[].type` | `"bigin" \| "production" \| "sandbox" \| "developer"` | No | — | type of org Allowed: `bigin`, `production`, `sandbox`, `developer`. |
| `result.data.org[].created_time` | `string` | No | — | time of creation Format: `date-time`. |
| `result.data.org[].mc_status` | `boolean \| null` | No | — | multi currency status |
| `result.data.org[].gapps_enabled` | `boolean` | No | — | google apps integration status |
| `result.data.org[].translation_enabled` | `boolean` | No | — | translation status |
| `result.data.org[].street` | `record` | No | — | Company's street |
| `result.data.org[].domain_name` | `string` | No | — | domain name of the organization Maximum length: 30. Pattern: `[a-z][a-z0-9]{4,30}`. |
| `result.data.org[].alias` | `record` | No | — | Company's alias |
| `result.data.org[].currency` | `string` | No | — | home currency Maximum length: 30. |
| `result.data.org[].id` | `string` | No | — | org id Maximum length: 20. |
| `result.data.org[].employee_count` | `record` | No | — | Company's employee count |
| `result.data.org[].state` | `record` | No | — | Company's state |
| `result.data.org[].fax` | `record` | No | — | Company's fax |
| `result.data.org[].zip` | `record` | No | — | Company's postal code |
| `result.data.org[].website` | `record` | No | — | Company's website |
| `result.data.org[].currency_symbol` | `string` | No | — | home currency symbol Minimum length: 1. Maximum length: 5. |
| `result.data.org[].mobile` | `record` | No | — | Company's mobile |
| `result.data.org[].currency_locale` | `string` | No | — | home currency locale Maximum length: 10. |
| `result.data.org[].primary_zuid` | `record` | No | — | — |
| `result.data.org[].zia_portal_id` | `string \| null` | No | — | zia portal id |
| `result.data.org[].time_zone` | `string` | No | — | Company's time zone Maximum length: 30. |
| `result.data.org[].zgid` | `string` | No | — | zgid Maximum length: 20. |
| `result.data.org[].country_code` | `string \| null` | No | — | Company's country code |
| `result.data.org[].deletable_org_account` | `boolean` | No | — | is deletable |
| `result.data.org[].license_details` | `object` | No | — | license details |
| `result.data.org[].license_details.paid_expiry` | `record` | No | — | license expiry date |
| `result.data.org[].license_details.users_license_purchased` | `integer` | Yes | — | no of users can be added based on the purchased licenses Format: `int32`. |
| `result.data.org[].license_details.trial_type` | `string \| null` | No | — | trial type |
| `result.data.org[].license_details.trial_expiry` | `string \| null` | No | — | trial expiry date |
| `result.data.org[].license_details.paid` | `boolean` | Yes | — | is paid edition account |
| `result.data.org[].license_details.paid_type` | `"free" \| "standard" \| "professional" \| "enterprise" \| "ultimate" \| "crmplus" \| "crmplusstarter" \| "zohooneenterprise" \| "zohoonestandard"` | Yes | — | actual license type Allowed: `free`, `standard`, `professional`, `enterprise`, `ultimate`, `crmplus`, `crmplusstarter`, `zohooneenterprise`, `zohoonestandard`. |
| `result.data.org[].license_details.portal_users_license_purchased` | `integer` | Yes | — | no of portal users can be added based on the purchased licenses Format: `int32`. |
| `result.data.org[].hierarchy_preferences` | `object` | No | — | hierarchy preference of an organization |
| `result.data.org[].hierarchy_preferences.type` | `"Role_Hierarchy" \| "Reporting_To_Hierarchy"` | Yes | — | type of hierarchy Allowed: `Role_Hierarchy`, `Reporting_To_Hierarchy`. |
| `result.data.org[].hierarchy_preferences.strictly_reporting` | `boolean \| null` | No | — | non reporting users data should be visible to CEO and Administator(true) or any user higher in the hierarchy(false) |
| `result.data.org[].phone` | `record` | No | — | Company's phone number |
| `result.data.org[].company_name` | `record` | No | — | Company's name |
| `result.data.org[].privacy_settings` | `boolean` | No | — | privacy settings enabled status |
| `result.data.org[].primary_email` | `record` | No | — | Email of the super admin |
| `result.data.org[].iso_code` | `string` | No | — | iso code of the home currency Maximum length: 10. |
| `result.data.org[].hipaa_compliance_enabled` | `boolean` | No | — | hipaa compliances enabled status |
| `result.data.org[].lite_users_enabled` | `boolean` | No | — | lite users enabled status |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "JSON Response",
"properties": {
"org": {
"type": "array",
"description": "array of organization details",
"maxItems": 1,
"items": {
"type": "object",
"description": "Company details",
"properties": {
"country": {
"type": "object",
"description": "Company's country",
"additionalProperties": true
},
"photo_id": {
"type": "object",
"description": "photo id of the company's logo",
"additionalProperties": true
},
"city": {
"type": "object",
"description": "Company's city",
"additionalProperties": true
},
"description": {
"type": "object",
"description": "description",
"additionalProperties": true
},
"type": {
"type": "string",
"description": "type of org",
"enum": [
"bigin",
"production",
"sandbox",
"developer"
]
},
"created_time": {
"type": "string",
"description": "time of creation",
"format": "date-time"
},
"mc_status": {
"type": [
"boolean",
"null"
],
"description": "multi currency status"
},
"gapps_enabled": {
"type": "boolean",
"description": "google apps integration status"
},
"translation_enabled": {
"type": "boolean",
"description": "translation status"
},
"street": {
"type": "object",
"description": "Company's street",
"additionalProperties": true
},
"domain_name": {
"type": "string",
"description": "domain name of the organization",
"maxLength": 30,
"pattern": "[a-z][a-z0-9]{4,30}"
},
"alias": {
"type": "object",
"description": "Company's alias",
"additionalProperties": true
},
"currency": {
"type": "string",
"description": "home currency",
"maxLength": 30
},
"id": {
"type": "string",
"description": "org id",
"maxLength": 20
},
"employee_count": {
"type": "object",
"description": "Company's employee count",
"additionalProperties": true
},
"state": {
"type": "object",
"description": "Company's state",
"additionalProperties": true
},
"fax": {
"type": "object",
"description": "Company's fax",
"additionalProperties": true
},
"zip": {
"type": "object",
"description": "Company's postal code",
"additionalProperties": true
},
"website": {
"type": "object",
"description": "Company's website",
"additionalProperties": true
},
"currency_symbol": {
"type": "string",
"description": "home currency symbol",
"minLength": 1,
"maxLength": 5
},
"mobile": {
"type": "object",
"description": "Company's mobile",
"additionalProperties": true
},
"currency_locale": {
"type": "string",
"description": "home currency locale",
"maxLength": 10
},
"primary_zuid": {
"type": "object",
"additionalProperties": true
},
"zia_portal_id": {
"type": [
"string",
"null"
],
"description": "zia portal id"
},
"time_zone": {
"type": "string",
"description": "Company's time zone",
"maxLength": 30
},
"zgid": {
"type": "string",
"description": "zgid",
"maxLength": 20
},
"country_code": {
"type": [
"string",
"null"
],
"description": "Company's country code"
},
"deletable_org_account": {
"type": "boolean",
"description": "is deletable"
},
"license_details": {
"type": "object",
"description": "license details",
"properties": {
"paid_expiry": {
"type": "object",
"description": "license expiry date",
"additionalProperties": true
},
"users_license_purchased": {
"type": "integer",
"description": "no of users can be added based on the purchased licenses",
"format": "int32"
},
"trial_type": {
"type": [
"string",
"null"
],
"description": "trial type"
},
"trial_expiry": {
"type": [
"string",
"null"
],
"description": "trial expiry date"
},
"paid": {
"type": "boolean",
"description": "is paid edition account"
},
"paid_type": {
"type": "string",
"description": "actual license type",
"enum": [
"free",
"standard",
"professional",
"enterprise",
"ultimate",
"crmplus",
"crmplusstarter",
"zohooneenterprise",
"zohoonestandard"
]
},
"portal_users_license_purchased": {
"type": "integer",
"description": "no of portal users can be added based on the purchased licenses",
"format": "int32"
}
},
"required": [
"users_license_purchased",
"paid",
"paid_type",
"portal_users_license_purchased"
],
"additionalProperties": false
},
"hierarchy_preferences": {
"type": "object",
"description": "hierarchy preference of an organization",
"properties": {
"type": {
"type": "string",
"description": "type of hierarchy",
"enum": [
"Role_Hierarchy",
"Reporting_To_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
},
"phone": {
"type": "object",
"description": "Company's phone number",
"additionalProperties": true
},
"company_name": {
"type": "object",
"description": "Company's name",
"additionalProperties": true
},
"privacy_settings": {
"type": "boolean",
"description": "privacy settings enabled status"
},
"primary_email": {
"type": "object",
"description": "Email of the super admin",
"additionalProperties": true
},
"iso_code": {
"type": "string",
"description": "iso code of the home currency",
"maxLength": 10
},
"hipaa_compliance_enabled": {
"type": "boolean",
"description": "hipaa compliances enabled status"
},
"lite_users_enabled": {
"type": "boolean",
"description": "lite users enabled status"
}
},
"additionalProperties": false
}
}
},
"required": [
"org"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)