Get Data of a Specific Role
To get the details of a specific role. Specify the unique ID of the role in your API request to get the data for that particular role.
Request URL
https://www.zohoapis.com/crm/v2/settings/roles/{role_id}
role_id - Specify the unique id of the role.
Request Method
GET
Scope
scope=ZohoCRM.settings.roles.{operation_type}
Possible operation types |
---|
ALL - Full access to roles data READ - get role data |
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2/settings/roles/2883756000000026005"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedZCRMRestClient restClient = ZCRMRestClient.getInstance();
APIResponse response = restClient.getOrganizationInstance().getRole(3719520000000026005L);
ZCRMRole role = (ZCRMRole) response.getData();
Copied def get_role(self):
try:
resp = ZCRMOrganization.get_instance().get_role(3719520000000026008)
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)
CopiedZCRMRestClient restClient = ZCRMRestClient.GetInstance();
APIResponse response = restClient.GetOrganizationInstance().GetRole(33721640000000); // 33721640000000 is role id
ZCRMRole role = (ZCRMRole)response.Data;
Sample Response
Copied{
"roles": [
{
"display_label": "CEO",
"name": "CEO",
"id": "2883756000000026005",
"reporting_to": null,
"admin_user": true
}
]
}
Copied{
"roles": [
{
"display_label": "CEO",
"name": "CEO",
"id": "3719520000000026005",
"reporting_to": null,
"admin_user": true
}
]
}
Copied{
"roles": [
{
"display_label": "CEO",
"name": "CEO",
"id": "2883756000000026005",
"reporting_to": null,
"admin_user": true
}
]
}
Copied{
"roles": [
{
"display_label": "CEO",
"name": "CEO",
"id": "2883756000000026005",
"reporting_to": null,
"admin_user": true
}
]
}
Sample Response
Copied{
"roles": [
{
"display_label": "CEO",
"name": "CEO",
"id": "2883756000000026005",
"reporting_to": null,
"admin_user": true
}
]
}
Copied{
"roles": [
{
"display_label": "CEO",
"name": "CEO",
"id": "3719520000000026005",
"reporting_to": null,
"admin_user": true
}
]
}
Copied{
"roles": [
{
"display_label": "CEO",
"name": "CEO",
"id": "2883756000000026005",
"reporting_to": null,
"admin_user": true
}
]
}
Copied{
"roles": [
{
"display_label": "CEO",
"name": "CEO",
"id": "2883756000000026005",
"reporting_to": null,
"admin_user": true
}
]
}
Sample Response
Copied{
"roles": [
{
"display_label": "CEO",
"name": "CEO",
"id": "2883756000000026005",
"reporting_to": null,
"admin_user": true
}
]
}
Copied{
"roles": [
{
"display_label": "CEO",
"name": "CEO",
"id": "3719520000000026005",
"reporting_to": null,
"admin_user": true
}
]
}
Copied{
"roles": [
{
"display_label": "CEO",
"name": "CEO",
"id": "2883756000000026005",
"reporting_to": null,
"admin_user": true
}
]
}
Copied{
"roles": [
{
"display_label": "CEO",
"name": "CEO",
"id": "2883756000000026005",
"reporting_to": null,
"admin_user": true
}
]
}