Get Portals

Portals

Portals in CRM allow the administrators to extend CRM access to their contacts, vendors or partners. A portal user can access the modules and some of the associated data that they have been given access to, such as products, invoices, and notes present in CRM. They can also view, edit, an create records, add notes and attachments.

Purpose

To get the details of the portals available in your org.

Endpoints

Request Details

Request URL

Get all portals - {api-domain}/crm/{version}/settings/portals
Get a specific portal - {api-domain}/crm/{version}/settings/portals/{portal_name}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.clientportal.ALL
(or)
Scope=ZohoCRM.settings.clientportal.READ

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v4/settings/portals/MyFirstCompany"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

  • NO_PERMISSIONHTTP 403

    You do not have "Manage Portal" and "Manage Portal Users" permissions.
    Resolution: Contact your administrator.

Sample Response

Copied{
    "portals": [
        {
            "created_time": "2021-11-25T16:13:33+05:30",
            "modified_time": "2021-11-25T16:13:33+05:30",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "name": "MyFirstCompany",
            "active": true,
            "zaid": "10xxx10",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            }
        }
    ]
}