Roles
Overview
In Bigin, an organization contains roles that establish a hierarchical structure for data access levels. These roles are assigned to users based on their data management responsibilities. Within the role hierarchy, users with higher-level roles can access the records of users with lower-level roles.
The Bigin administrators assign roles to users. Roles such as Managers, Sales Reps, Supervisors, Product Management Staff, and so on determines the different levels of user roles in an organization. By default, CEO and Manager roles are made available in Bigin.
Endpoints
Get all roles data
Retrieves the list of available roles and their properties in an organization.
Request URL
Bigin APIs are available across eight different domains, and you must choose the one relevant to your data center (DC):
- US
- EU
- AU
- IN
- CN
- JP
- SA
- CA
Authorization
For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.
Authorization: Zoho-oauthtoken <ACCESS_TOKEN>
You must authenticate using an access token that is associated with one of the following scopes:
- ZohoBigin.settings.roles.ALL
- ZohoBigin.settings.roles.READ
Request parameters
The request parameters aren't available for this endpoint.
Sample request
Copiedcurl "https://www.zohoapis.com/bigin/v2/settings/roles" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/bigin/v2/settings/roles"
type: GET
connection:"connection_link_name"
];
info response;Response object
The response object contains a list of available modules with the following details:
display_label string
The display label of the role. For example, CEO or Manager.
forecast_manager jsonobject
Contains the details of the forecast manager.
share_with_peers boolean
Has the value true if users with the current role have permission to share records with other users or the value false if they have no permission to share records with other users.
name string
The name of the current role.
description string
Indicates the description of the role.
reporting_to jsonobject
The JSON object contains the role data which is above the current role in the role hierarchy.
id string
The unique identifier of the role.
Sample response
Copied{
"roles": [
{
"display_label": "CEO",
"forecast_manager": null,
"share_with_peers": true,
"name": "CEO",
"description": "Users with this role have access to the data owned by all other users.",
"reporting_to": null,
"id": "2034020000000015966"
},
{
"display_label": "Sales Manager",
"forecast_manager": null,
"share_with_peers": false,
"name": "Sales Manager",
"description": "Users belonging to this role cannot see data for admin users.",
"reporting_to": {
"name": "CEO",
"id": "2034020000000015966"
},
"id": "2034020000000015969"
},
{
"display_label": "Marketing Manager",
"forecast_manager": null,
"share_with_peers": false,
"name": "Marketing Manager",
"description": "Users belonging to this role cannot see data for admin users.",
"reporting_to": {
"name": "CEO",
"id": "2034020000000015966"
},
"id": "2034020000000472026"
},
{
"display_label": "Sales Team Lead",
"forecast_manager": null,
"share_with_peers": false,
"name": "Sales Team Lead",
"description": "null",
"reporting_to": {
"name": "Sales Manager",
"id": "2034020000000015969"
},
"id": "2034020000000472039"
},
{
"display_label": "Marketing Coordinator",
"forecast_manager": null,
"share_with_peers": false,
"name": "Marketing Coordinator",
"description": "null",
"reporting_to": {
"name": "Marketing Manager",
"id": "2034020000000472026"
},
"id": "2034020000000472045"
}
]
}