Get all portals
This API allows users to retrieve a list of all portals associated within their Zoho Backstage account. A portal in Zoho Backstage is a workspace that can host multiple events, and this API returns essential information about each portal, including its ID, name, domain, and owner details.
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
OAuth Scope
zohobackstage.portal.READ
Response Structure and Field Explanations
The response from the "Get All Portals" API is structured as an array of objects, with each object providing comprehensive details about a specific portal within your Zoho Backstage account. Below are the fields included in each portal object, along with detailed explanations:
- id (Long Integer)
This field represents the unique identifier assigned to each portal. For example, "id": "12345678" indicates that the portal has the ID 12345678. This ID is critical for distinguishing between different portals, especially when managing multiple portals within a single account.
- name (String)
The name field specifies the name given to the portal. For instance, "name": "Marketing" might be used to identify a portal dedicated to marketing events. The name provides a quick reference for understanding the portal’s purpose or the team it is associated with, making it easier to manage and navigate through multiple portals.
- domain (String)
The domain field contains the domain associated with the portal. For example, "domain": "marketing.zohobackstage.com" specifies the web address where the portal can be accessed. This domain is typically used to access the event website and should be unique across all your portals.
- is_default (Boolean)
This field indicates whether the portal is set as the default portal for your account. A value of true means that this portal is the default one, which might be the primary portal you use for most events or interactions. Conversely, a value of false indicates that the portal is not the default. For example, "is_default": true suggests that this portal is the default portal.
- owner_name (String)
The owner_name field contains the name of the individual who owns or manages the portal. For example, "owner_name": "Sam" identifies the person responsible for the portal’s administration. Knowing the owner is particularly useful when you need to collaborate or delegate tasks related to the portal’s maintenance.
- owner_email (String)
The owner_email field holds the email address of the portal owner. For instance, "owner_email": "sam@zoho.com" provides the contact information for the portal’s administrator.
URL
Copied/v3/portals
Example
Copiedhttps://zohoapis.com/backstage/v3/portals
Sample Response
Copied{
"portals": [
{
"id": "12345678",
"name": "Marketing",
"domain": "marketing.zohobackstage.com",
"is_default": true,
"owner_name": "sam",
"owner_email": "sam@zoho.com"
}
]
}