组织 API
目的
获取组织数据。
端点
- GET /org
Request 详情
Request URL
{api-domain}/crm/{version}/org
标题
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.org.{operation_type}
可能的操作类型
ALL - 对组织数据的完全访问权限
READ - 获取组织数据
样本请求
Response JSON 键
- 国家,城市,街道,州,邮编字符串
代表组织的地址。
- photo_id string
代表组织照片文件的唯一ID。请参考上传文件API以获取更多详情。
- description string
代表有关组织的描述(如果有的话)。
- alias string
代表组织的别名。
- created_time string
表示创建组织的日期和时间。
- type string
代表组织的环境类型。可能的值有生产,沙箱,bigin和开发者。
- currency string
代表了组织的基础/主要货币详情。
- deletable_org_account boolean
表示此组织相关的账户是否可删除。
- id string
代表组织的唯一ID。
- 传真,手机,主要电子邮件,电话字符串
代表组织的联系方式。
- employee_count string
代表组织中的员工数量。
- website string
代表该组织的网站。
- currency_symbol string
代表组织指定的基础/主页货币的符号。例如,'₹'。
- currency_locale string
代表为组织指定的基础/主页货币的地区设置。例如,'en_IN'。
- primary_zuid string
代表组织的ZUID。这是在Zoho CRM UI的个人资料详细信息中可见的ID。
- zia_portal_id string
如果已配置,代表组织的Zia门户ID。
- time_zone string
代表组织的时区。
- zgid string
代表组织的唯一ZGID。
- country_code string
代表组织所属国家的唯一代码。例如,'IN'。
- license_details JSON 对象
代表组织的许可证详情。
- company_name string
代表组织中公司的名称。
- iso_code string
代表组织的基础/主页货币的ISO代码。
- privacy_settings boolean
代表组织是否启用了隐私设置。
可能的值 - true: 组织已启用隐私设置。
false: 组织已禁用隐私设置。 - mc_status boolean
表示组织是否启用了多货币功能。
可能的值 - true: 组织已启用多货币功能。
false: 组织已禁用多货币功能。 - gapps_enabled boolean
表示是否为组织启用了Google Apps集成。
可能的值 - true: 为组织启用了Google Apps集成。
false: 为组织禁用了Google Apps集成。 - domain_name string
代表组织的域名。例如,org694902300。
- translation_enabled boolean
表示组织是否启用了翻译。
可能的值 - true: 组织已启用翻译。
false: 组织已禁用翻译。 - hipaa_compliance_enabled boolean
代表组织是否启用了HIPAA合规性。
可能的值 - true: 组织已启用HIPAA合规性。
false: 组织已禁用HIPAA合规性。
可能的错误
- INVALID_URL_PATTERNHTTP 404
请检查试图访问的URL是否正确
解决方案: 指定的请求URL不正确。请指定一个有效的请求URL。请参考上述请求URL部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未授权
解决方案: 客户端没有ZohoCRM.org.READ范围。创建一个具有有效范围的新客户端。请参考上述范围部分。 - NO_PERMISSIONHTTP 403
拒绝读取权限
解决方案:用户没有读取记录的权限。请联系您的系统管理员。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中出现意外且未处理的异常。请联系支持团队。 - INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方案:您指定了无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参考上述端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限读取组织数据
解决方案:用户没有权限检索组织数据。请联系您的系统管理员。