Introduction
Welcome to the Zoho Backstage API Guide. Zoho Backstage is a comprehensive event management platform designed to simplify and enhance the way you plan, execute, and analyze events. Whether you’re organizing a small seminar or a large conference, Zoho Backstage offers a suite of tools to help you manage every aspect of your event.
Overview of Zoho Backstage API
The Zoho Backstage API provides developers with the ability to integrate and automate all tasks available within the Zoho Backstage web application. Constructed on REST principles, this API ensures consistent and predictable URLs, making it easier to develop applications that integrate seamlessly with Zoho Backstage. The API is fully compliant with HTTP standards, ensuring compatibility with a wide range of HTTP clients and making it straightforward to integrate with existing systems.
Key Features
The API allows you to interact with various aspects of Zoho Backstage, including managing events, attendees, speakers, and more. Each resource in the API is accessible via a unique URL, retrievable from the API Root Endpoint, simplifying navigation and interaction with the API. This framework enhances the development process for integrating Zoho Backstage features into bespoke applications.
Multiple Data Centers
Zoho Backstage is hosted across multiple data centers globally, and its APIs are available on different domains corresponding to these data centers. There are five distinct domains for Zoho Backstage APIs, each associated with a specific region. It is important to use the correct domain based on your data center.
Data Center | Domain | Base API |
United States | .com | https://zohoapis.com/backstage |
Europe | .eu | https://zohoapis.eu/backstage |
India | .in | https://zohoapis.in/backstage |
Australia | .com.au | https://zohoapis.com.au/backstage |
Japan | .jp | https://zohoapis.jp/backstage |
Saudi Arabia | .sa | https://zohoapis.sa/backstage |
Canada | .ca | https://zohoapis.ca/backstage |
The APIs on this page are for portals in Zoho Backstage hosted on the '.com' domain. If your portal is on a different domain, you must replace '.com' with the appropriate domain for API endpoints on this page before using them.
Note: To determine which domain your Zoho Backstage portal is hosted on, check the URL of the Zoho Backstage web app you are accessing. If the URL contains backstage.zoho.com, then you're accessing it from the .com domain. If the URL contains backstage.zoho.in, you're accessing it from the '.in' domain. Similarly, you could be accessing Zoho Backstage from the '.eu', '.com.au', or '.jp' domain.
For example, here's how you would modify the domain in an API endpoint for the .eu domain:
API endpoint for the .com domain, as available on this page:
https://www.zohoapis.com/backstage/v3/portals
API endpoint after replacing the .com domain with .eu:
https://www.zohoapis.eu/backstage/v3/portals
List of scopes available in Zoho Backstage
Module | Scopes |
Portal | zohobackstage.portal.READ |
Event | zohobackstage.event.READ, zohobackstage. event.CREATE, zohobackstage.event.UPDATE, zohobackstage.event.DELETE |
Members | zohobackstage.portal.READ, zohobackstage.event.READ |
Agenda | zohobackstage.agenda.READ, zohobackstage.agenda.CREATE, zohobackstage.agenda.UPDATE, zohobackstage.agenda.DELETE |
Speaker | zohobackstage.speaker.READ, zohobackstage.speaker.CREATE, zohobackstage.speaker.UPDATE, zohobackstage.speaker.DELETE |
Sponsor | zohobackstage.sponsor.READ, zohobackstage.sponsor.CREATE, zohobackstage.sponsor.UPDATE, zohobackstage.sponsor.DELETE |
Event Ticket | zohobackstage.eventticket.READ, zohobackstage.eventticket.CREATE, zohobackstage.eventticket.UPDATE, zohobackstage.eventticket.DELETE |
Order | zohobackstage.order.READ, zohobackstage.order.CREATE, zohobackstage.order.UPDATE, zohobackstage.order.DELETE |
Attendee | zohobackstage.attendee.READ, zohobackstage.attendee.UPDATE, zohobackstage.attendee.DELETE |
Webhook | zohobackstage.webhook.READ, zohobackstage.webhook.CREATE, zohobackstage.webhook.UPDATE, zohobackstage.webhook.DELETE |