- Overview
- What's New in V5?
- Changelog
- OAuth Authentication
- Multi DC Support
- GDPR Compliance
- HIPAA Compliance
- HTTP Request Methods
- Status Codes
- Metadata APIs
- GETModule
- GETFields
- GETLayouts
- GETRelated Lists
- Profiles
- Custom View
- Roles
- Territories
- GETTerritories
- POSTTerritories
- PUTTerritories
- DELETETerritories
- POSTTransfer and Delete Territories
- GETChild Territories of a Territory
- POSTAssign Territories to Records
- GETTerritories Assigned
- POSTRemove Territories of Records
- GETAssociated User Count
- PUTAssociate Users with Territory
- DELETEDisassociate Users from Territory
- GETRetrieve User details Associated with a Territory
- Scoring Rules
- Variables
- Map Dependency
- User Groups
- Tags
- Pipeline
- Wizards
- Assignment Rules
- Templates
- User's Unavailability
- Portals
- Fiscal Year
- Business Hours
- Holidays
- Shift Hours
- REST APIs
- Modules
- Organization
- Users
- Records
- Related Records
- Records APIs using External ID
- Meeting Cancel
- Subforms
- Linking Modules
- Contact Roles
- Photos and Attachments
- Mass Update
- Mass Delete
- Currencies
- Files
- Share
- Fields' Attachments
- Change Owner
- Mass Change Owner
- Blueprint
- Emails
- Notes
- Related Records Using External ID
- Composite API
- Bulk APIs
- Notification APIs
- Query API
Get Portals
Portals
Portals allow the administrators to extend 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 the solution. They can also view, edit, an create records, add notes and attachments.
Purpose
To get the details of the portals available in your org.
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://zylkercorp.zohoplatform.com/crm/v5/settings/portals/MyFirstCompany"
-X GET
-H "Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52"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"
}
}
]
}Show full
Show less
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.