Profiles APIs
In Zoho Vertical Solutions, the administrator assigns a profile to every user which decides the user's level of access to the account data. Use this API to get the details of different profiles.
Get Profiles
Purpose
To retrieve the data of profiles of your organization.
Request Details
Request URL
{api-domain}/crm/v2/settings/profiles
To get a specific profile:
{api-domain/crm/v2/settings/profiles/{profile_id}
Header
Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.profiles.{operation_type}
Possible operation types
ALL - Full access to profiles data
READ - Retrieve profiles data
Sample Request
Copiedcurl "https://zylkercorp.zohoplatform.com/crm/v2/settings/profiles"
-X GET
-H "Authorization: Zoho-oauthtoken 100xx.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copied//Get instance of ProfilesOperations Class that takes If-Modified-Since header as parameter.
//To include If-Modified-Since header in the request, get the instance as follows
let profilesOperations = new ZCRM.Profile.Operations(new Date(2017,9,1,12,12,12));
//To not include If-Modified-Since header to the request, get the instance as follows
// let profilesOperations = new ZCRM.Profile.Operations(null);
//Call getProfiles method
let response = await profilesOperations.getProfiles();
Copiedvar listener = 0;
class ProfilesAPIs {
async getProfiles() {
var url = "https://zylkercorp.zohoplatform.com/crm/v2/settings/profiles"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/redirect.html",
scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
}
var accesstoken = await new ProfilesAPIs().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
var requestMethod = "GET"
var reqBody = null
var params = "";
parameters.forEach(function(value, key) {
if (parameters.has(key)) {
if (params) {
params = params + key + '=' + value + '&';
}
else {
params = key + '=' + value + '&';
}
}
});
var apiHeaders = {};
if(headers) {
headers.forEach(function(value, key) {
apiHeaders[key] = value;
});
}
if (params.length > 0){
url = url + '?' + params.substring(0, params.length - 1);
}
var requestObj = {
uri : url,
method : requestMethod,
headers : apiHeaders,
body : JSON.stringify(reqBody),
encoding: "utf8",
allowGetBody : true,
throwHttpErrors : false
};
var result = await new ProfilesAPIs().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async getProfile() {
var url = "https://zylkercorp.zohoplatform.com/crm/v2/settings/profiles/34770626011"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/redirect.html",
scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
}
var accesstoken = await new ProfilesAPIs().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
var requestMethod = "GET"
var reqBody = null
var params = "";
parameters.forEach(function(value, key) {
if (parameters.has(key)) {
if (params) {
params = params + key + '=' + value + '&';
}
else {
params = key + '=' + value + '&';
}
}
});
var apiHeaders = {};
if(headers) {
headers.forEach(function(value, key) {
apiHeaders[key] = value;
});
}
if (params.length > 0){
url = url + '?' + params.substring(0, params.length - 1);
}
var requestObj = {
uri : url,
method : requestMethod,
headers : apiHeaders,
body : JSON.stringify(reqBody),
encoding: "utf8",
allowGetBody : true,
throwHttpErrors : false
};
var result = await new ProfilesAPIs().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async getToken(token) {
if(listener == 0) {
window.addEventListener("storage", function(reponse) {
if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
location.reload();
}
if(reponse.key === "access_token"){
sessionStorage.removeItem("__auth_process");
}
}, false);
listener = 1;
if(sessionStorage.getItem("__auth_process")) {
sessionStorage.removeItem("__auth_process");
}
}
["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
var isKeyExists = localStorage.hasOwnProperty(k);
if(isKeyExists) {
sessionStorage.setItem(k, localStorage[k]);
}
localStorage.removeItem(k);
});
var valueInStore = sessionStorage.getItem("access_token");
var tokenInit = sessionStorage.getItem("__token_init");
if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
valueInStore = null;
sessionStorage.removeItem("access_token");
}
var auth_process = sessionStorage.getItem("__auth_process");
if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
var accountsUrl = "https://zylkercorp.zohoplatform.com/oauth/v2/auth"
var clientId;
var scope;
var redirectUrl;
if(token != null) {
clientId = token.clientId;
scope = token.scope;
redirectUrl = token.redirectUrl;
}
var fullGrant = sessionStorage.getItem("full_grant");
var grantedForSession = sessionStorage.getItem("granted_for_session");
if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
accountsUrl += '/refresh';
}
if (clientId && scope) {
sessionStorage.setItem("__token_init", Date.now());
sessionStorage.removeItem("access_token");
sessionStorage.setItem("__auth_process", "true");
window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
var isKeyExists = localStorage.hasOwnProperty(k);
if(isKeyExists){
sessionStorage.setItem(k, localStorage[k]);
}
localStorage.removeItem(k);
});
valueInStore = sessionStorage.getItem("access_token");
}
}
if(token != null && valueInStore != 'undefined'){
token.accessToken = valueInStore;
}
return token.accessToken;
}
async makeAPICall(requestDetails) {
return new Promise(function (resolve, reject) {
var body, xhr, i;
body = requestDetails.body || null;
xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.open(requestDetails.method, requestDetails.uri, true);
for (i in requestDetails.headers) {
xhr.setRequestHeader(i, requestDetails.headers[i]);
}
xhr.send(body);
xhr.onreadystatechange = function() {
if(xhr.readyState == 4) {
resolve(xhr);
}
}
})
}
}
Copiedresponse = invokeurl
[
url: "https://zylkercorp.zohoplatform.com/crm/v2/settings/profiles"
type: GET
connection:"crm_oauth_connection"
];
info response;
Response JSON Keys
- display_labelstring
Represents the display name of the current profile.
- created_timestring
Represents the date and time at which the current profile was created.
- modified_timestring
Represents the date and time at which the current profile was last modified.
- namestring
Represents the name of the profile.
- modified_byJSON object
Represents the name and ID of the user who last modified the current profile.
- descriptionstring
Represents the description of the profile, if any.
- idstring
Represents the unique ID of the profile.
- created_byJSON object
Represents the name and ID of the user who created the current profile.
- categoryboolean
Represents if the profile is a default profile. The value is true only for "Standard" and "Administrator" profiles.
Possible Errors
- INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.settings.profiles.READ scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to read
Resolution: The user does not have permission to read profiles data. Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to read profiles
Resolution: The user does not have the permission to retrieve profiles data. Contact your system administrator.
Sample Response
Copied{
"profiles": [
{
"display_label": "Administrator",
"created_time": null,
"modified_time": "2020-04-01T12:57:59+05:30",
"name": "Administrator",
"modified_by": {
"name": "Patricia Boyle",
"id": "4150868000000225013"
},
"description": "This profile will have all the permissions. Users with Administrator profile will be able to view and manage all the data within the organization account by default.",
"id": "4150868000000026011",
"category": false,
"created_by": null
},
{
"display_label": "Standard",
"created_time": null,
"modified_time": "2020-04-01T12:34:58+05:30",
"name": "Standard",
"modified_by": {
"name": "Patricia Boyle",
"id": "4150868000000225013"
},
"description": "This profile will have all the permissions except administrative privileges.",
"id": "4150868000000026014",
"category": false,
"created_by": null
},
{
"display_label": "sample",
"created_time": "2020-03-13T16:28:12+05:30",
"modified_time": "2020-07-06T18:58:59+05:30",
"name": "sample",
"modified_by": {
"name": "Patricia Boyle",
"id": "4150868000000225013"
},
"description": "This is a sample profile",
"id": "4150868000001623001",
"category": true,
"created_by": {
"name": "Patricia Boyle",
"id": "4150868000000225013"
}
}
]
}