Get a specific portal

The "Get a Specific Portal" API allows users to retrieve detailed information about a specific portal within their Zoho Backstage account. To access this information, users maust provide the portal_id, which uniquely identifies the portal. The portal_id can be located in the URL of your Zoho Backstage portal.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

OAuth Scope

zohobackstage.portal.READ

Path Parameters  

• portal_id (Long Integer) 
  The unique identifier of the portal you wish to access. This ID is required to retrieve the specific portal's details. For example, "portal_id": "12345678" would request information for the portal with that ID.

   

Response Structure and Field Explanations  

The response provides a JSON object containing detailed information about the specific portal. Below are the fields included in the response, along with explanations:

• id (Long Integer) 
  This field represents the unique identifier assigned to the portal. For example, "id": "12345678" indicates that the portal has the ID 12345678. This ID is essential for distinguishing this portal from others in your account, especially when managing or referencing specific portals.
• name (String) 
  The name field indicates the name assigned to the portal. For instance, "name": "Marketing" may refer to a portal dedicated to marketing-related events. The name helps in easily identifying the portal's purpose or the team it is associated with.
• domain (String) 
  The domain field contains the domain name associated with the portal. For example, "domain": "marketing.zohobackstage.com" specifies the web address where the portal can be accessed. This domain is unique to the portal and is used for direct access.
• 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, making it the primary portal for certain actions. Conversely, false indicates it is not the default portal. For instance, "is_default": true" suggests that this is the primary portal used within your account.
• 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 portal's administrator, which is useful when contacting the owner for management tasks or collaboration.
• owner_email (String) 
  The owner_email field provides the email address of the portal owner. For example, "owner_email": "sam@zoho.com" offers the necessary contact information for reaching out to the portal administrator, whether for notifications or resolving issues.