Zoho crm Logo

角色 API

在Zoho CRM中,Admin为用户分配Role。Role,如经理、Sales代表、主管、产品管理Staff等,表示公司中不同级别的员工。使用此API可以检索Zoho CRM中各种Role的信息。

获取 角色

目的

获取有关您组织中角色的详细信息。

端点

  • GET /settings/roles
  • GET /settings/roles/{role_ID}

请求详情

请求URL

检索所有角色:
{api-domain}/crm/{version}/settings/roles

获取特定角色:
{api-domain}/crm/{version}/settings/roles/{role_ID}

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.roles.{operation_type}

可能的操作类型

全部 - 完全访问角色数据
读取 - 检索角色数据

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/roles/3652397000010189001"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/settings/roles/3652397000010189001"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

响应 JSON

  • display_labelstring

    表示当前角色的显示名称。

  • share_with_peersboolean

    表示具有当前角色的用户是否有权限共享记录。
    可能的值:
    true: 具有当前角色的用户可以与其他用户共享记录。
    false: 具有当前角色的用户不能与其他用户共享记录。

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

    HTTP 请求方法类型无效
    解决方法:您指定了一个无效的 HTTP 方法来访问 API URL。请指定一个有效的请求方法。请参阅本页开头的端点部分。

  • AUTHORIZATION_FAILEDHTTP 400

    用户没有足够的权限读取角色
    解决方案:用户没有权限检索角色数据。请联系您的系统管理员。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您用于进行此 API 调用的访问令牌不具有所需的范围。
    解决方案:生成一个具有此 API 所需范围的新访问令牌。请参阅本页开头的范围部分以获取所需范围的列表。

  • NO_PERMISSIONHTTP 403

    没有权限读取
    解决方案:用户没有读取角色数据的权限。请联系系统管理员。

  • INVALID_URL_PATTERNHTTP 404

    请求的URL不正确。
    解决方法:指定一个有效的请求URL。有关详细信息,请参阅本页开头的请求URL部分。

  • INTERNAL_ERRORHTTP 500

    内部服务器错误
    解决方案:服务器中出现意外且未处理的异常。请联系支持团队。

示例响应

Copied{
    "roles": [
        {
            "display_label": "SalesRep",
            "created_by__s": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "modified_by__s": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "forecast_manager": null,
            "share_with_peers": true,
            "modified_time__s": "2022-11-10T17:25:02+05:30",
            "name": "SalesRep",
            "description": null,
            "reporting_to": {
                "name": "Manager",
                "id": "3652397000000026008"
            },
            "id": "3652397000010189001",
            "created_time__s": "2022-11-10T17:25:02+05:30"
        }
    ]
}