Roles APIs

In Zoho CRM, Administrators assign roles to the users. Roles, such as Managers, Sales Reps, Supervisors, Product Management Staff, etc., denote the different levels of employees in a company. Use this API to retrieve information about various roles in Zoho CRM.

Get roles

Purpose

To retrieve the data of roles through an API request.

Request URL

https://www.zohoapis.com/crm/v2/settings/roles

Request Method

GET

Scope

scope=ZohoCRM.settings.roles.{operation_type}

Possible operation types
ALL - Full access to roles data
READ - get role data
CurlJavaPythonCsharp

Sample Request


				curl "https://www.zohoapis.com/crm/v2/settings/roles"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Sample Response


				{
    "roles": [
       {
            "display_label": "CEO",
            "name": "CEO",
            "id": "2883756000000026005",
            "reporting_to": null,
            "admin_user": true
        },
       {
            "display_label": "Manager",
            "name": "Manager",
            "id": "2883756000000026008",
            "reporting_to": {
                "name": "CEO",
                "id": "2883756000000026005"
            },
            "admin_user": false
        },
       {
            "display_label": "Supervisors",
            "name": "Supervisors",
            "id": "2883756000000243007",
            "reporting_to": {
                "name": "Manager",
                "id": "2883756000000026008"
            },
            "admin_user": false
        },
       {
            "display_label": "Sales Reps",
            "name": "Sales Reps",
            "id": "2883756000000243013",
            "reporting_to": {
                "name": "Supervisors",
                "id": "2883756000000243007"
            },
            "admin_user": false
        },
       {
            "display_label": "Product Managers",
            "name": "Product Managers",
            "id": "2883756000000243019",
            "reporting_to": {
                "name": "CEO",
                "id": "2883756000000026005"
            },
            "admin_user": false
        }
    ]
}

Sample Request


				ZCRMRestClient restClient = ZCRMRestClient.getInstance();
BulkAPIResponse response = restClient.getOrganizationInstance().getAllRoles();
List<ZCRMRole> roles = (List<ZCRMRole>) response.getData(); // roles - list of ZCRMRole instance

Sample Response


				{
    "roles": [
       {
            "display_label": "CEO",
            "name": "CEO",
            "id": "2883756000000026005",
            "reporting_to": null,
            "admin_user": true
        },
       {
            "display_label": "Manager",
            "name": "Manager",
            "id": "2883756000000026008",
            "reporting_to": {
                "name": "CEO",
                "id": "2883756000000026005"
            },
            "admin_user": false
        },
       {
            "display_label": "Supervisors",
            "name": "Supervisors",
            "id": "2883756000000243007",
            "reporting_to": {
                "name": "Manager",
                "id": "2883756000000026008"
            },
            "admin_user": false
        },
       {
            "display_label": "Sales Reps",
            "name": "Sales Reps",
            "id": "2883756000000243013",
            "reporting_to": {
                "name": "Supervisors",
                "id": "2883756000000243007"
            },
            "admin_user": false
        },
       {
            "display_label": "Product Managers",
            "name": "Product Managers",
            "id": "2883756000000243019",
            "reporting_to": {
                "name": "CEO",
                "id": "2883756000000026005"
            },
            "admin_user": false
        }
    ]
}

Sample Request


				def get_roles(self):
        try:
            resp = ZCRMOrganization.get_instance().get_all_roles()
            roles = resp.data
            print(resp.status_code)
            for role in roles:
                print("\n\n")
                print(role.name)
                print(role.id)
                print(role.display_label)
                print(role.is_admin)
                if role.reporting_to is not None:
                    print(role.reporting_to.id)
                    print(role.reporting_to.name)

        except ZCRMException as ex:
            print(ex.status_code)
            print(ex.error_message)
            print(ex.error_code)
            print(ex.error_details)
            print(ex.error_content)

Sample Response


				{
    "roles": [
       {
            "display_label": "CEO",
            "name": "CEO",
            "id": "2883756000000026005",
            "reporting_to": null,
            "admin_user": true
        },
       {
            "display_label": "Manager",
            "name": "Manager",
            "id": "2883756000000026008",
            "reporting_to": {
                "name": "CEO",
                "id": "2883756000000026005"
            },
            "admin_user": false
        },
       {
            "display_label": "Supervisors",
            "name": "Supervisors",
            "id": "2883756000000243007",
            "reporting_to": {
                "name": "Manager",
                "id": "2883756000000026008"
            },
            "admin_user": false
        },
       {
            "display_label": "Sales Reps",
            "name": "Sales Reps",
            "id": "2883756000000243013",
            "reporting_to": {
                "name": "Supervisors",
                "id": "2883756000000243007"
            },
            "admin_user": false
        },
       {
            "display_label": "Product Managers",
            "name": "Product Managers",
            "id": "2883756000000243019",
            "reporting_to": {
                "name": "CEO",
                "id": "2883756000000026005"
            },
            "admin_user": false
        }
    ]
}

Sample Request


				ZCRMRestClient restClient = ZCRMRestClient.GetInstance();
BulkAPIResponse<ZCRMRole> response = restClient.GetOrganizationInstance().GetAllRoles();
List<ZCRMRole> roles = response.BulkData; // roles - list of ZCRMRole instance

Sample Response


				{
    "roles": [
       {
            "display_label": "CEO",
            "name": "CEO",
            "id": "2883756000000026005",
            "reporting_to": null,
            "admin_user": true
        },
       {
            "display_label": "Manager",
            "name": "Manager",
            "id": "2883756000000026008",
            "reporting_to": {
                "name": "CEO",
                "id": "2883756000000026005"
            },
            "admin_user": false
        },
       {
            "display_label": "Supervisors",
            "name": "Supervisors",
            "id": "2883756000000243007",
            "reporting_to": {
                "name": "Manager",
                "id": "2883756000000026008"
            },
            "admin_user": false
        },
       {
            "display_label": "Sales Reps",
            "name": "Sales Reps",
            "id": "2883756000000243013",
            "reporting_to": {
                "name": "Supervisors",
                "id": "2883756000000243007"
            },
            "admin_user": false
        },
       {
            "display_label": "Product Managers",
            "name": "Product Managers",
            "id": "2883756000000243019",
            "reporting_to": {
                "name": "CEO",
                "id": "2883756000000026005"
            },
            "admin_user": false
        }
    ]
}