Profiles APIs

In Bigin, the administrator assigns a profile to every user which decides the user's level of access to Bigin 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

https://www.zohoapis.com/bigin/v1/settings/profiles

Scope

scope=ZohoBigin.settings.profiles.{operation_type}

Possible operation types

ALL - Full access to profiles data
READ - Retrieve profiles data

Sample Request

Copiedcurl "https://www.zohoapis.com/bigin/v1/settings/profiles"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedZBiginRestClient restClient = ZBiginRestClient.getInstance();
BulkAPIResponse response = restClient.getOrganizationInstance().getAllProfiles();
List<ZBiginProfile> profiles = (List<ZBiginProfile>) response.getData();
Copieddef get_profiles(self):
        try:
            resp = ZBiginOrganization.get_instance().get_all_profiles()
            profiles = resp.data
            print(resp.status_code)
            for profile in profiles:
                print("\n\n")
                print(profile.name)
                print(profile.id)
                print(profile.is_default)
                print(profile.created_time)
                print(profile.modified_time)
                print(profile.modified_by)
                print(profile.description)
                print(profile.created_by)
                print(profile.category)
                print(profile.permissions)
                sections = profile.sections
                if sections is not None:
                    for section in sections:
                        print(section.name)
                        print(section.categories)
        except ZBiginException as ex:
            print(ex.status_code)
            print(ex.error_message)
            print(ex.error_code)
            print(ex.error_details)
            print(ex.error_content)
CopiedZBiginRestClient restClient = ZBiginRestClient.GetInstance();
BulkAPIResponse<ZBiginProfile> response = restClient.GetOrganizationInstance().GetAllProfiles();
List<ZBiginProfile> profiles = response.BulkData; // profiles - list of ZBiginProfile instance
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v1/settings/profiles"
	type: GET
	connection:"bigin_oauth_connection"
];
info response;

 

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"
            }
        }
    ]
}