Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Payroll software with automated tax payments and filing.

Try now
New

Robotic process automation software to automate high-volume, rule-based tasks.

Try for free
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Privacy-friendly application analytics solution.

Try for free

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
 
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

 
Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

 
Desk

Helpdesk software to deliver great customer support.

Desk
 
Assist

Remote support and unattended remote access software.

Assist
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

End-to-end field service management platform for service businesses.

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

Create, edit, and share slides with a sleek presentation app.

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

 
Creator

Build custom apps to simplify business processes.

Creator
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

Project Management

 
Projects

Manage, track, and collaborate on projects with teams.

Projects
 
Sprints

Planning and tracking tool for scrum teams.

Sprints
 
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep

IoT

 
NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

 
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
 
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
 
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
 
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
 
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
 
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
 
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho One
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Marketplace
Skip to main content

Get all events

The "Get All Events" API enables users to retrieve comprehensive information about all events created within their Zoho Backstage portal. You can filter, sort, and paginate through the events based on various criteria.

 

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

 

OAuth Scope

zohobackstage.event.READ

 

 Path Parameters 

  • portal_id (Long Integer)
    The unique identifier of the portal for which you want to retrieve event information. For example, "portal_id": "19593237" specifies that events should be fetched for the portal with ID 19593237.

 Query Parameters 

  • status (String)
    This parameter filters events based on their status. The possible values are:
    • all: Includes all events.
    • live: Events currently live.
    • drafts: Events that are in draft status.
    • completed: Events that have been completed.
    • canceled: Events that have been canceled.
    • trash: Events that are in the trash. 
  • sort_by (String)
    Determines the attribute by which events should be sorted. Values include:
    • start_date: Sort by the event's start date.
    • created_time: Sort by the creation time of the event.
    • last_modified_time: Sort by the last modification time of the event.
  • sort_order (String)
    Specifies the order in which events should be sorted. Values are:
    • asc: Sort in ascending order.
    • desc: Sort in descending order.

Response Structure and Field Explanations 

The response contains pagination information and an array of event objects, each providing detailed information about individual events.

pagination (Object)

Provides information about the pagination of the event list.

  • total_count (Integer)
    The total number of events available. For example, "total_count": 2 indicates that there are 2 events.
  • page (Integer)
    The current page number of the event list. For example, "page": 1 signifies that this is page 1.
  • per_page (Integer)
    The number of events included per page. For example, "per_page": 50 means 50 events are displayed per page.
  • total_pages (Integer)
    The total number of pages available. For example, "total_pages": 1 means there is only one page of events.
  • has_more_items (Boolean)
    Indicates whether there are additional events beyond the current page. For example, "has_more_items": false shows that there are no more events.

events (Array Of Object)

An array of event objects, each with the following fields:

  • id (Long Integer) 
    A unique identifier for the event. For example, "id": "20000000003002" identifies the event with ID 20000000003002.
  • space (Object)
    Details about the space associated with the event.
    • id (Long Integer)
      The ID of the space. For example, "id": "20000000000011" specifies the space ID. 
  • timezone (String)
    The timezone in which the event is scheduled. For example, "timezone": "America/New_York".
  • status (Integer)
    The status of the event represented by a numeric value. The possible values are:
    • 0: Unpublished
    • 1: Published
    • 2: Running
    • 3: Completed
    • 4: Canceled 
  • status_string (String)
    The status of the event in string format. For example, "status_string": "published".
  • category (String)
    The category under which the event falls. For example, "category": "OTHERS".
  • tags (Array Of String)
    Tags associated with the event. For example, "tags": ["Sales", "Marketing"].
  • language (String)
    The default language of the event. For example, "language": "English".
  • name (String)
    The name of the event. For example, "name": "Marketing Event".
  • description (String)
    A detailed description of the event. For example, "description": "Description added updated".
  • summary (String)
    A brief summary of the event. For example, "summary": "Summary added".
  • created_by (Object)
    Information about the creator of the event.
    • id (Long Integer)
      The ID of the creator. For example, "id": "20000000000001".
    • email (String)
      The email address of the creator. For example, "email": "sam@zoho.com".
    • first_name (String)
      The first name of the creator. For example, "first_name": "Sam".
    • company (String)
      The company of the creator. For example, "company": "ZOHO".
    • designation (String)
      The designation of the creator. For example, "designation": "Manager". 
  • created_time (String)
    The timestamp of when the event was created, in UTC format. For example, "created_time": "2024-03-25T11:51:15Z".
  • last_modified_by (Object)
    Information about the last person who modified the event.
    • id (Long Integer)
      The ID of the last modifier. For example, "id": "20000000000001".
    • email (String)
      The email address of the last modifier. For example, "email": "sam@zoho.com".
    • first_name (String)
      The first name of the last modifier. For example, "first_name": "Sam".
    • company (String)
      The company of the last modifier. For example, "company": "ZOHO".
    • designation (String)
      The designation of the last modifier. For example, "designation": "Manager".
  • last_modified_time (String)
    The timestamp of when the event was last modified, in UTC format. For example, "last_modified_time": "2024-03-25T11:51:15Z".
  • event_type (Integer)
    The type of the event represented by a numeric value. The possible values are:
    • 2: Venue
    • 3: Online
    • 4: Hybrid
  • event_type_string (String)
    Type of the event in string format. For example, "event_type_string": "Venue".
  • start_time (String)
    The start time of the event, in UTC format. For example, "start_time": "2024-10-04T11:30:00Z".
  • end_time (String)
    The end time of the event, in UTC format. For example, "end_time": "2024-10-05T11:30:00Z".
  • website_url (String)
    The website URL for the event. For example, "website_url": "https://restapi.zohobackstage.com/marketingEvent".

     

  • social_handles (Object)
    An object containing links to the event's social media handles.
    • medium (String)
      The URL to the event's Medium page. For example, "medium": "https://medium.com/zoho".

    • twitter (String)
      The URL to the event's Twitter page. For example, "twitter": "https://twitter.com/zoho".

    • website (String)
      The official website of the event. For example, "website": "https://www.techsummit2024.com".

    • youtube (String)
      The URL to the event's YouTube channel. For example, "youtube": "https://www.youtube.com/channel/xyz".

    • facebook (String)
      The URL to the event's Facebook page. For example, "facebook": "https://www.facebook.com/zoho".

    • instagram (String)
      The URL to the event's Instagram page. For example, "instagram": "https://www.instagram.com/zoho".
    • linkedin (String)
      The URL to the event's LinkedIn page. For example, "linkedin": "https://www.linkedin.com/zoho".
    • telegram (String)
      The URL to the event's Telegram channel. For example, "telegram": "https://telegram.org/zoho".
  • thumbnail_url (String) 
    The URL to the event's thumbnail image. For example, "thumbnail_url": "https://zbc.zohobackstage.com/public/portals/12345678/siteResources/20000000013175".

  • venues (Object)
    Details about the event venue, if applicable.

    • name (String)
      The name of the venue. For example, "name": "Tech Convention Center".
    • street (String)
      The street address of the venue. For example, "street": "123 Tech Lane".
    • city (String)
      The city where the venue is located. For example, "city": "San Francisco".
    • state (String)
      The state where the venue is located. For example, "state": "CA".
    • country (String)
      The country where the venue is located. For example, "country": "USA".

URL

Copied/v3/portals/{portal_id}/events

Example

Copiedhttps://zohoapis.com/backstage/v3/portals/19593237/events

Samples Response

Copied{
    "pagination": {
        "total_count": 2,
        "page": 1,
        "per_page": 50,
        "total_pages": 1,
        "has_more_items": false
    },
    "events": [
        {
            "id": "20000000003002",
            "space": {
                "id": "20000000000011"
            },
            "timezone": "America/New_York",
            "status": 1,
            "status_string": "published",
            "category": "OTHERS",
            "tags": [
                "salse",
                "marketing"
            ],
            "language": "en",
            "name": "Marketing Event",
            "description": "Description added",
            "summary": "summary updated",
            "created_by": {
                "id": "20000000000001",
                "email": "sam@zoho.com",
                "first_name": "sam",
                "company": "ZOHO",
                "designation": "Manager"
            },
            "created_time": "2024-03-25T11:51:15Z",
            "last_modified_by": {
                "id": "20000000000001",
                "email": "sam@zoho.com",
                "first_name": "sam",
                "company": "ZOHO",
                "designation": "Manager"
            },
            "last_modified_time": "2024-03-25T11:51:15Z",
            "event_type": 2,
            "event_type_string": "venue",
            "start_time": "2024-10-04T11:30:00Z",
            "end_time": "2024-10-05T11:30:00Z",
            "website_url": "https://restapi.zohobackstage.com/marketingEvent",
            "social_handles": {
                "medium": "https://medium.com/zoho",
                "twitter": "https://twitter.com/zoho",
                "website": "www.zoho.com",
                "youtube": "https://www.youtube.com/channel/xyz",
                "facebook": "https://www.facebook.com/zoho",
                "instagram": "https://www.instagram.com/zoho",
                "linkedin": "https://www.linkedin.com/zoho",
                "telegram": "https://telegram.org/zoho"
            },
            "thumbnail_url": "https://zbc.zohobackstage.com/public/portals/12345678/siteResources/20000000013175",
            "venues": {
                "name": "221B",
                "street": "Bakers Street",
                "city": "Chennai",
                "state": "Tamil Nadu",
                "country": "India"
            }
        },
        {
            "id": "20000000013175",
            "space": {
                "id": "20000000000011"
            },
            "timezone": "Asia/Calcutta",
            "status": 1,
            "status_string": "published",
            "category": "SALES",
            "tags": [
                "salse",
                "marketing"
            ],
            "language": "en",
            "name": "Sales Event",
            "description": "Description added updated",
            "summary": "summary updated",
            "created_by": {
                "id": "20000000000001",
                "email": "sam@zoho.com",
                "first_name": "peter",
                "company": "ZOHO",
                "designation": "Manager"
            },
            "created_time": "2024-03-25T11:54:29Z",
            "last_modified_by": {
                "id": "20000000000001",
                "email": "sam@zoho.com",
                "first_name": "peter",
                "company": "ZOHO",
                "designation": "Manager"
            },
            "last_modified_time": "2024-03-25T11:54:29Z",
            "event_type": 2,
            "event_type_string": "venue",
            "start_time": "2024-10-04T11:30:00Z",
            "end_time": "2024-10-05T11:30:00Z",
            "website_url": "https://restapi.zohobackstage.com/salesEvent",
            "social_handles": {
                "medium": "https://medium.com/zoho",
                "twitter": "https://twitter.com/zoho",
                "website": "www.zoho.com",
                "youtube": "https://www.youtube.com/channel/xyz",
                "facebook": "https://www.facebook.com/zoho",
                "instagram": "https://www.instagram.com/zoho",
                "linkedin": "https://www.linkedin.com/zoho",
                "telegram": "https://telegram.org/zoho"
            },
            "thumbnail_url": "https://zbc.zohobackstage.com/public/portals/12345678/siteResources/20000000013175",
            "venues": {
                "name": "Tech Convention Center",
                "street": "123 Tech Lane",
                "city": "San Francisco",
                "state": "CA",
                "country": "USA"
            }
        }
    ]
}