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.
- id (Long Integer)
- 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".
- id (Long Integer)
- 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".
- id (Long Integer)
- 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".
- name (String)
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"
}
}
]
}