- Overview
- What's New in V7?
- Changelog
- API Directory
- API Collection
- OAuth Authentication
- OAuth Scopes
- API Limits
- Multi DC Support
- Increase API Credits
- Customize API Usage Notification
- GDPR Compliance
- HIPAA Compliance
- API Dashboard
- HTTP Request Methods
- Status Codes
- Zoho CRM SDKs
- Metadata APIs
- Modules
- Fields
- Layouts
- Related Lists
- Profiles
- Custom View
- Roles
- Global Picklists
- Territories
- GETTerritories
- POSTTerritories
- PUTTerritories
- DELETETerritories
- POSTTransfer and Delete Territories
- GETChild Territories of a Territory
- GETTerritories Assigned
- GETAssociated User Count
- GETRetrieve User details Associated with a Territory
- PUTAssociate Users with Territory
- POSTRemove Territories of Records
- POSTAssign Territories to Records
- DELETEDisassociate Users from Territory
- Scoring Rules
- Variables
- Map Dependency
- Duplicate Check Option
- Data Enrichment
- Create Export Audit Log
- User Groups
- Tags
- Unsubscribe Links
- Cadences
- Pipeline
- Wizards
- Assignment Rules
- Templates
- User's Unavailability
- Portals
- Fiscal Year
- Business Hours
- Holidays
- Record Locking Configuration
- Shift Hours
- Entity APIs
- Organization
- Users
- Records
- Related Records
- Records APIs using External ID
- Related Records Using External ID
- Merge Records
- List of Available APIs
- Features
- Meeting Cancel
- Linking Modules
- Subforms
- Contact Roles
- Photos and Attachments
- Mass Update
- Mass Delete
- Currencies
- Files
- Share
- Fields Attachments
- Recycle Bin
- Change Owner
- Mass Change Owner
- Emails
- Blueprint
- Notes
- Bulk APIs
- Composite API
- Notification APIs
- Query API
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.
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/v7/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"
}
}
]
}
Show full
Show less
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.