Get a specific event

The "Get a Specific Event" API allows users to retrieve detailed information about a specific event by providing the event_id within their Zoho Backstage portal. This endpoint is useful for obtaining comprehensive details about a particular event, including its status, schedule, and other attributes.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

OAuth Scope

zohobackstage.event.READ

Path Parameters   

• portal_id (Long Integer) 
  The unique identifier of the portal where the event is hosted. For example, "portal_id": "19593237" refers to the portal with ID 19593237.
• event_id (Long Integer) 
  The unique identifier of the event for which details are being requested. For example, "event_id": "2000000000022" specifies the event with ID 2000000000022. 

Response Structure and Field Explanations

The response provides detailed information about the specified event, structured in various fields to give a comprehensive overview of the event's attributes.

• id (Long Integer) 
  A unique identifier for the event. For example, "id": "27000000000023" identifies the event with ID 27000000000023.
• space (Object) 
  Details about the space associated with the event.
  • id (Long Integer) 
    The ID of the space associated with the event. For example, "id": "2700000011" 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": "completed".
• 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": "en" sets the default language of the event to 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".
• summary (String) 
  A 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": "27000000000001".
  • 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-05-16T10:00:29Z".
• 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": "27000000000001".
  • 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-05-31T12:45:32Z".
• 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) 
  The 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-05-23T02:30:00Z".
• end_time (String) 
  The end time of the event, in UTC format. For example, "end_time": "2024-05-27T11:30:59Z".
• 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/27000000000023".
• venue (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".