Zoho Backstage

Event management. Create and update events, add speakers and sessions, register attendees, and read orders, tickets and attendees.

Actions

Action	What it does
Add a speaker	Add a speaker to an event.
Create a session	Add a session to an event's agenda.
Create an event	Create an event.
Create an order	Register someone for an event: an order for one ticket of the chosen class.
Delete an event	Delete an event, with its speakers, agenda, tickets and orders.
Get a session	Get a session's details and speakers.
Get a speaker	Get a speaker's profile.
Get an attendee	Get an attendee's ticket, order and contact details.
Get an event	Get an event's details, dates and venue.
Get an order	Get an order's purchaser, tickets and cost.
List attendees	List an event's attendees, optionally for one ticket.
List event members	List the people on an event's organizing team and their roles.
List events	List the portal's events, optionally filtered by status.
List orders	List an event's ticket orders.
List portals	List the Backstage portals this connection reaches.
List sessions	List the sessions on an event's agenda, optionally for one day.
List speakers	List an event's speakers.
List ticket classes	List an event's ticket classes, with prices and how many are sold.
List tracks	List the tracks of an event's agenda.
Update an event	Change an event's name, time zone, dates or details.

Add a speaker

Add a speaker to an event. They start as invited. The Free plan allows 3 speakers per event.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
EmailemailtextRequired: The speaker's email address.
First namefirst_nametextRequired: The speaker's first name.
Last namelast_nametext: Optional.
Companycompanytext: Optional.
Job titledesignationtext: Optional.
Biographydescriptiontext: Optional. A short biography.
Countrycountrytext: Optional. A two-letter country code, such as US.
Phonetelephonetext: Optional.
Skillsskillslist: Optional. The speaker's skills, such as Sales, Marketing.
Featuredfeaturedtrue/false: Optional. Feature the speaker on the event site.
LinkedInlinkedintext: Optional. Their LinkedIn profile address.
X (Twitter)twittertext: Optional. Their X (Twitter) profile address.
Facebookfacebooktext: Optional. Their Facebook profile address.
Instagraminstagramtext: Optional. Their Instagram profile address.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

A speaker at the event.

added_ontext: When they were added.
alternate_telephonetext: Another phone number.
companytext: Their company.
countrytext: Their two-letter country code.
descriptiontext: Their biography.
designationtext: Their job title.
emailtext: Their email address.
facebooktext: Their Facebook profile.
featuredtrue/false: Whether they are featured.
first_nametext: Their first name.
idtext: The speaker's id.
instagramtext: Their Instagram profile.
joined_ontext: When they joined.
last_nametext: Their last name.
linkedintext: Their LinkedIn profile.
mediumtext: Their Medium profile.
skillstext: Their skills, comma-separated.
statusnumber: 0 invited, 1 joined.
status_stringtext: The status as text.
telegramtext: Their Telegram profile.
telephonetext: Their phone number.
twittertext: Their X (Twitter) profile.

Example output

{
  "company": "Acme",
  "country": "US",
  "designation": "CTO",
  "email": "speaker@example.com",
  "featured": false,
  "first_name": "Sam",
  "id": "2263000000013001",
  "last_name": "Speaker",
  "status": 0,
  "status_string": "invited"
}

Create a session

Add a session to an event's agenda. The Free plan allows 3 sessions per event, each at most 45 minutes.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
TitletitletextRequired: The session's title.
Tracktrack_idtextRequired: The track it belongs to, from 'List tracks'.
Startsstart_timedate and timeRequired: When it starts. It must fall within the event.
Duration (minutes)durationnumber: Optional. How long it lasts, in minutes.From 1 to 1440.
Session typesession_typetext: Optional. Such as KEYNOTE, PRESENTATION or BREAK. Defaults to KEYNOTE.Default: KEYNOTE.
Daydaynumber: Optional. Which day of the event, counting from 1.At least 1. Default: 1.
Speakersspeaker_emailslist: Optional. The email addresses of the event's speakers who present it.
Featuredfeaturedtrue/false: Optional. Feature the session.
Hiddenhiddentrue/false: Optional. Hide it from attendees.
Time to be announcedtime_to_be_announcedtrue/false: Optional. Show the time as to be announced.
Venue to be announcedvenue_to_be_announcedtrue/false: Optional. Show the venue as to be announced.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

A session on the event's agenda.

agendatext: The agenda it belongs to.
created_byobject: A Backstage user.
created_timetext: When it was created.
descriptiontext: Its description.
durationnumber: How long it lasts, in minutes.
featuredtrue/false: Whether it is featured.
hiddentrue/false: Whether it is hidden from attendees.
idtext: The session's id.
languagetext: Its language code.
last_modified_byobject: A Backstage user.
last_modified_timetext: When it was last changed.
session_typetext: Its type, e.g. KEYNOTE.
speaker_to_be_announcedtrue/false: Whether its speaker is still to be announced.
speakerslist: Its speakers.
start_timetext: When it starts, in UTC.
titletext: The session's title.
tracktext: The id of its track.
venuetext: The hall it takes place in.
venue_to_be_announcedtrue/false: Whether its venue is still to be announced.

Example output

{
  "duration": 30,
  "featured": false,
  "hidden": false,
  "id": "2263000000014001",
  "session_type": "KEYNOTE",
  "speakers": [
    {
      "company": "Acme",
      "country": "US",
      "designation": "CTO",
      "email": "speaker@example.com",
      "featured": false,
      "first_name": "Sam",
      "id": "2263000000013001",
      "last_name": "Speaker",
      "status": 0,
      "status_string": "invited"
    }
  ],
  "start_time": "2026-11-04T15:00:00Z",
  "title": "Opening keynote",
  "track": "2263000000011021"
}

Create an event

Create an event. It starts unpublished.

Inputs

NamenametextRequired: The event's name.
Time zonetimezonetextRequired: The event's time zone.One of: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, and 544 more. Default: UTC.
Startsstart_timedate and timeRequired: When the event starts.
Endsend_timedate and timeRequired: When the event ends. The Free plan allows one event day.
Event typeevent_typetext: Optional. In person, online or hybrid.One of: venue (In person (venue)), online, hybrid.
Languagelanguagetext: Optional. The event's language code, such as en.
Summarysummarytext: Optional. A short summary.
Descriptiondescriptiontext: Optional. The full description; HTML is allowed.
Categorycategorytext: Optional. The event's category, such as Sales.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

A Zoho Backstage event.

categorytext: The event's category.
created_byobject: A Backstage user.
created_timetext: When it was created.
descriptiontext: The event's description (HTML).
end_timetext: When it ends, in UTC.
event_typenumber: 2 venue, 3 online, 4 hybrid.
event_type_stringtext: The event type as text.
idtext: The event's id.
languagetext: The event's language code, e.g. en.
last_modified_byobject: A Backstage user.
last_modified_timetext: When it was last changed.
nametext: The event's name.
spaceobject: The event's space.
start_timetext: When it starts, in UTC, e.g. 2026-11-04T09:00:00Z.
statusnumber: 0 unpublished, 1 published, 2 running, 3 completed, 4 canceled.
status_stringtext: The status as text, e.g. unpublished.
summarytext: A short summary.
tagslist: The event's tags.
thumbnail_urltext: The event's thumbnail image.
timezonetext: The event's IANA time zone, e.g. America/New_York.
venueobject: Where the event takes place.
website_urltext: The event website's address.

Example output

{
  "category": "Sales",
  "created_by": {
    "company": "Acme",
    "designation": "Organizer",
    "email": "owner@example.com",
    "first_name": "Ola",
    "id": "2263000000002003"
  },
  "created_time": "2026-10-01T09:00:00Z",
  "description": "<p>Our yearly summit.</p>",
  "end_time": "2026-11-04T22:00:00Z",
  "event_type": 3,
  "event_type_string": "online",
  "id": "2263000000011005",
  "language": "en",
  "last_modified_by": {
    "company": "Acme",
    "designation": "Organizer",
    "email": "owner@example.com",
    "first_name": "Ola",
    "id": "2263000000002003"
  },
  "last_modified_time": "2026-10-01T09:00:00Z",
  "name": "Customer Summit",
  "space": {
    "id": "2263000000011001"
  },
  "start_time": "2026-11-04T14:00:00Z",
  "status": 0,
  "status_string": "unpublished",
  "summary": "Our yearly summit.",
  "tags": [],
  "timezone": "America/New_York",
  "website_url": "https://example.zohobackstage.com/CustomerSummit"
}

Create an order

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Ticket classticket_class_idtextRequired: The ticket class, from 'List ticket classes'.
Purchaser first namepurchaser_first_nametextRequired: The buyer's first name.
Purchaser last namepurchaser_last_nametext: Optional.
Purchaser emailpurchaser_emailtextRequired: The buyer's email address.
Purchaser companypurchaser_companytext: Optional.
Purchaser mobilepurchaser_mobile_notext: Optional.
Attendee first nameattendee_first_nametext: Optional. Defaults to the purchaser's.
Attendee last nameattendee_last_nametext: Optional. Defaults to the purchaser's.
Attendee emailattendee_emailtext: Optional. Defaults to the purchaser's.
Billing address line 1billing_address_line_1text: Optional. The billing address is sent only when given.
Billing address line 2billing_address_line_2text: Optional.
Billing citybilling_citytext: Optional.
Billing statebilling_statetext: Optional.
Billing countrybilling_countrytext: Optional.
Billing postal codebilling_zip_codetext: Optional.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

An order for tickets.

billing_addressobject: The billing address.
contactobject: The purchaser.
costobject: What the order costs.
created_timetext: When it was placed.
idtext: The order's id.
last_modified_timetext: When it was last changed.
order_bytext: The purchaser's email address.
origin_stringtext: The order's origin as text.
payment_option_nametext: The payment option's name.
payment_statusnumber: 1 paid, 2 unpaid.
payment_status_stringtext: The payment status as text.
payment_typenumber: How it was paid for.
payment_type_stringtext: The payment type as text.
sourcenumber: Where the order came from.
source_stringtext: The source as text, e.g. api.
statusnumber: 0 placed, 1 cancelled, 3 paid to the organizer.
status_stringtext: The status as text.
ticketslist: The order's tickets.

Example output

{
  "contact": {
    "purchaser_email": "buyer@example.com",
    "purchaser_first_name": "Bea",
    "purchaser_last_name": "Buyer"
  },
  "cost": {
    "sub_total": 0,
    "total": 0
  },
  "created_time": "2026-10-02T10:00:00Z",
  "id": "2263000000015001",
  "order_by": "buyer@example.com",
  "payment_status": 1,
  "payment_status_string": "paid",
  "source_string": "api",
  "status": 0,
  "status_string": "placed",
  "tickets": [
    {
      "contact": {
        "email": "buyer@example.com",
        "first_name": "Bea",
        "last_name": "Buyer"
      },
      "id": "2263000000015011",
      "ticket_class_id": "2263000000011031",
      "ticket_name": "General admission",
      "total": 0
    }
  ]
}

Delete an event

Delete an event, with its speakers, agenda, tickets and orders.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

The outcome of deleting an event.

deletedtrue/false: Always true: a refusal raises an error instead.
event_idtext: The deleted event's id.
messagetext: Zoho's confirmation, without its HTML.

Example output

{
  "deleted": true,
  "event_id": "2263000000011005",
  "message": "Your Customer Summit event has been deleted"
}

Get a session

Get a session's details and speakers.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Session IDsession_idtextRequired: The session's id, from 'List sessions' or 'Create a session'.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

A session on the event's agenda.

agendatext: The agenda it belongs to.
created_byobject: A Backstage user.
created_timetext: When it was created.
descriptiontext: Its description.
durationnumber: How long it lasts, in minutes.
featuredtrue/false: Whether it is featured.
hiddentrue/false: Whether it is hidden from attendees.
idtext: The session's id.
languagetext: Its language code.
last_modified_byobject: A Backstage user.
last_modified_timetext: When it was last changed.
session_typetext: Its type, e.g. KEYNOTE.
speaker_to_be_announcedtrue/false: Whether its speaker is still to be announced.
speakerslist: Its speakers.
start_timetext: When it starts, in UTC.
titletext: The session's title.
tracktext: The id of its track.
venuetext: The hall it takes place in.
venue_to_be_announcedtrue/false: Whether its venue is still to be announced.

Example output

{
  "duration": 30,
  "featured": false,
  "hidden": false,
  "id": "2263000000014001",
  "session_type": "KEYNOTE",
  "speakers": [
    {
      "company": "Acme",
      "country": "US",
      "designation": "CTO",
      "email": "speaker@example.com",
      "featured": false,
      "first_name": "Sam",
      "id": "2263000000013001",
      "last_name": "Speaker",
      "status": 0,
      "status_string": "invited"
    }
  ],
  "start_time": "2026-11-04T15:00:00Z",
  "title": "Opening keynote",
  "track": "2263000000011021"
}

Get a speaker

Get a speaker's profile.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Speaker IDspeaker_idtextRequired: The speaker's id, from 'List speakers' or 'Add a speaker'.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

A speaker at the event.

added_ontext: When they were added.
alternate_telephonetext: Another phone number.
companytext: Their company.
countrytext: Their two-letter country code.
descriptiontext: Their biography.
designationtext: Their job title.
emailtext: Their email address.
facebooktext: Their Facebook profile.
featuredtrue/false: Whether they are featured.
first_nametext: Their first name.
idtext: The speaker's id.
instagramtext: Their Instagram profile.
joined_ontext: When they joined.
last_nametext: Their last name.
linkedintext: Their LinkedIn profile.
mediumtext: Their Medium profile.
skillstext: Their skills, comma-separated.
statusnumber: 0 invited, 1 joined.
status_stringtext: The status as text.
telegramtext: Their Telegram profile.
telephonetext: Their phone number.
twittertext: Their X (Twitter) profile.

Example output

{
  "company": "Acme",
  "country": "US",
  "designation": "CTO",
  "email": "speaker@example.com",
  "featured": false,
  "first_name": "Sam",
  "id": "2263000000013001",
  "last_name": "Speaker",
  "status": 0,
  "status_string": "invited"
}

Get an attendee

Get an attendee's ticket, order and contact details.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Attendee IDattendee_idtextRequired: The attendee's id, from 'List attendees'.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

An attendee of the event.

affiliate_nametext: The affiliate the ticket came through.
contactobject: The attendee's details.
created_timetext: When it was created.
event_idtext: The event's id.
idtext: The attendee's id.
last_modified_timetext: When it was last changed.
order_idtext: The id of the order that bought the ticket.
portaltext: The portal's id.
promo_codetext: The promo code used.
purchased_bytext: Who bought the ticket.
statusnumber: 0 not attending, 1 attending.
status_stringtext: The status as text.
ticket_class_idtext: The ticket class's id.
ticket_idtext: The ticket's id.
ticket_nametext: The ticket class's name.

Example output

{
  "contact": {
    "email": "buyer@example.com",
    "first_name": "Bea",
    "last_name": "Buyer"
  },
  "event_id": "2263000000011005",
  "id": "2263000000016001",
  "order_id": "2263000000015001",
  "portal": "2263000000002001",
  "status": 1,
  "status_string": "attending",
  "ticket_class_id": "2263000000011031",
  "ticket_id": "2263000000015011",
  "ticket_name": "General admission"
}

Get an event

Get an event's details, dates and venue.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

A Zoho Backstage event.

categorytext: The event's category.
created_byobject: A Backstage user.
created_timetext: When it was created.
descriptiontext: The event's description (HTML).
end_timetext: When it ends, in UTC.
event_typenumber: 2 venue, 3 online, 4 hybrid.
event_type_stringtext: The event type as text.
idtext: The event's id.
languagetext: The event's language code, e.g. en.
last_modified_byobject: A Backstage user.
last_modified_timetext: When it was last changed.
nametext: The event's name.
spaceobject: The event's space.
start_timetext: When it starts, in UTC, e.g. 2026-11-04T09:00:00Z.
statusnumber: 0 unpublished, 1 published, 2 running, 3 completed, 4 canceled.
status_stringtext: The status as text, e.g. unpublished.
summarytext: A short summary.
tagslist: The event's tags.
thumbnail_urltext: The event's thumbnail image.
timezonetext: The event's IANA time zone, e.g. America/New_York.
venueobject: Where the event takes place.
website_urltext: The event website's address.

Example output

{
  "category": "Sales",
  "created_by": {
    "company": "Acme",
    "designation": "Organizer",
    "email": "owner@example.com",
    "first_name": "Ola",
    "id": "2263000000002003"
  },
  "created_time": "2026-10-01T09:00:00Z",
  "description": "<p>Our yearly summit.</p>",
  "end_time": "2026-11-04T22:00:00Z",
  "event_type": 3,
  "event_type_string": "online",
  "id": "2263000000011005",
  "language": "en",
  "last_modified_by": {
    "company": "Acme",
    "designation": "Organizer",
    "email": "owner@example.com",
    "first_name": "Ola",
    "id": "2263000000002003"
  },
  "last_modified_time": "2026-10-01T09:00:00Z",
  "name": "Customer Summit",
  "space": {
    "id": "2263000000011001"
  },
  "start_time": "2026-11-04T14:00:00Z",
  "status": 0,
  "status_string": "unpublished",
  "summary": "Our yearly summit.",
  "tags": [],
  "timezone": "America/New_York",
  "website_url": "https://example.zohobackstage.com/CustomerSummit"
}

Get an order

Get an order's purchaser, tickets and cost.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Order IDorder_idtextRequired: The order's id, from 'List orders' or 'Create an order'.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

An order for tickets.

billing_addressobject: The billing address.
contactobject: The purchaser.
costobject: What the order costs.
created_timetext: When it was placed.
idtext: The order's id.
last_modified_timetext: When it was last changed.
order_bytext: The purchaser's email address.
origin_stringtext: The order's origin as text.
payment_option_nametext: The payment option's name.
payment_statusnumber: 1 paid, 2 unpaid.
payment_status_stringtext: The payment status as text.
payment_typenumber: How it was paid for.
payment_type_stringtext: The payment type as text.
sourcenumber: Where the order came from.
source_stringtext: The source as text, e.g. api.
statusnumber: 0 placed, 1 cancelled, 3 paid to the organizer.
status_stringtext: The status as text.
ticketslist: The order's tickets.

Example output

{
  "contact": {
    "purchaser_email": "buyer@example.com",
    "purchaser_first_name": "Bea",
    "purchaser_last_name": "Buyer"
  },
  "cost": {
    "sub_total": 0,
    "total": 0
  },
  "created_time": "2026-10-02T10:00:00Z",
  "id": "2263000000015001",
  "order_by": "buyer@example.com",
  "payment_status": 1,
  "payment_status_string": "paid",
  "source_string": "api",
  "status": 0,
  "status_string": "placed",
  "tickets": [
    {
      "contact": {
        "email": "buyer@example.com",
        "first_name": "Bea",
        "last_name": "Buyer"
      },
      "id": "2263000000015011",
      "ticket_class_id": "2263000000011031",
      "ticket_name": "General admission",
      "total": 0
    }
  ]
}

List attendees

List an event's attendees, optionally for one ticket.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Ticket IDticket_idtext: Optional. Only the attendee holding this ticket.
Pagepagenumber: Optional. Which page of results to return, starting at 1.At least 1.
Page sizeper_pagenumber: Optional. How many to return per page, 1 to 200. Zoho's default is 200.From 1 to 200.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

attendeeslist: The attendees.
countnumber: How many attendees are in this answer.
has_moretrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho pages the list.
per_pagenumber: The page size, when Zoho pages the list.
total_countnumber: How many attendees there are in all, when Zoho says.

Example output

{
  "attendees": [
    {
      "contact": {
        "email": "buyer@example.com",
        "first_name": "Bea",
        "last_name": "Buyer"
      },
      "event_id": "2263000000011005",
      "id": "2263000000016001",
      "order_id": "2263000000015001",
      "portal": "2263000000002001",
      "status": 1,
      "status_string": "attending",
      "ticket_class_id": "2263000000011031",
      "ticket_id": "2263000000015011",
      "ticket_name": "General admission"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1,
  "per_page": 200,
  "total_count": 1
}

List event members

List the people on an event's organizing team and their roles.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

countnumber: How many event members are in this answer.
has_moretrue/false: Whether another page is available.
memberslist: The event members.
pagenumber: This page's number, when Zoho pages the list.
per_pagenumber: The page size, when Zoho pages the list.
total_countnumber: How many event members there are in all, when Zoho says.

Example output

{
  "count": 1,
  "has_more": false,
  "members": [
    {
      "email": "owner@example.com",
      "first_name": "Ola",
      "id": "2263000000002003",
      "last_name": "Owner",
      "role": "Event Owner",
      "status": 1,
      "status_string": "joined"
    }
  ],
  "page": 1,
  "per_page": 200,
  "total_count": 1
}

List events

List the portal's events, optionally filtered by status.

Inputs

Statusstatustext: Optional. Only events in this state.One of: all, running, live (Live (published)), drafts, completed, canceled, trash.
Sort bysort_bytext: Optional. Which date to sort by.One of: start_date (Start date), created_time (Created time), last_modified_time (Last modified time).
Ordersort_ordertext: Optional. Ascending or descending.One of: asc (Oldest first), desc (Newest first).
Pagepagenumber: Optional. Which page of results to return, starting at 1.At least 1.
Page sizeper_pagenumber: Optional. How many to return per page, 1 to 200. Zoho's default is 200.From 1 to 200.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

countnumber: How many events are in this answer.
eventslist: The events.
has_moretrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho pages the list.
per_pagenumber: The page size, when Zoho pages the list.
total_countnumber: How many events there are in all, when Zoho says.

Example output

{
  "count": 1,
  "events": [
    {
      "category": "Sales",
      "created_by": {
        "company": "Acme",
        "designation": "Organizer",
        "email": "owner@example.com",
        "first_name": "Ola",
        "id": "2263000000002003"
      },
      "created_time": "2026-10-01T09:00:00Z",
      "description": "<p>Our yearly summit.</p>",
      "end_time": "2026-11-04T22:00:00Z",
      "event_type": 3,
      "event_type_string": "online",
      "id": "2263000000011005",
      "language": "en",
      "last_modified_by": {
        "company": "Acme",
        "designation": "Organizer",
        "email": "owner@example.com",
        "first_name": "Ola",
        "id": "2263000000002003"
      },
      "last_modified_time": "2026-10-01T09:00:00Z",
      "name": "Customer Summit",
      "space": {
        "id": "2263000000011001"
      },
      "start_time": "2026-11-04T14:00:00Z",
      "status": 0,
      "status_string": "unpublished",
      "summary": "Our yearly summit.",
      "tags": [],
      "timezone": "America/New_York",
      "website_url": "https://example.zohobackstage.com/CustomerSummit"
    }
  ],
  "has_more": false,
  "page": 1,
  "per_page": 200,
  "total_count": 1
}

List orders

List an event's ticket orders.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Statusstatustext: Optional. Only placed or only cancelled orders.One of: all, placed, cancelled.
Ordersort_ordertext: Optional. Ascending or descending.One of: asc (Oldest first), desc (Newest first).
Pagepagenumber: Optional. Which page of results to return, starting at 1.At least 1.
Page sizeper_pagenumber: Optional. How many to return per page, 1 to 200. Zoho's default is 200.From 1 to 200.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

countnumber: How many orders are in this answer.
has_moretrue/false: Whether another page is available.
orderslist: The orders.
pagenumber: This page's number, when Zoho pages the list.
per_pagenumber: The page size, when Zoho pages the list.
total_countnumber: How many orders there are in all, when Zoho says.

Example output

{
  "count": 1,
  "has_more": false,
  "orders": [
    {
      "contact": {
        "purchaser_email": "buyer@example.com",
        "purchaser_first_name": "Bea",
        "purchaser_last_name": "Buyer"
      },
      "cost": {
        "sub_total": 0,
        "total": 0
      },
      "created_time": "2026-10-02T10:00:00Z",
      "id": "2263000000015001",
      "order_by": "buyer@example.com",
      "payment_status": 1,
      "payment_status_string": "paid",
      "source_string": "api",
      "status": 0,
      "status_string": "placed",
      "tickets": [
        {
          "contact": {
            "email": "buyer@example.com",
            "first_name": "Bea",
            "last_name": "Buyer"
          },
          "id": "2263000000015011",
          "ticket_class_id": "2263000000011031",
          "ticket_name": "General admission",
          "total": 0
        }
      ]
    }
  ],
  "page": 1,
  "per_page": 200,
  "total_count": 1
}

List portals

List the Backstage portals this connection reaches.

Inputs

None.

Outputs

countnumber: How many portals are in this answer.
has_moretrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho pages the list.
per_pagenumber: The page size, when Zoho pages the list.
portalslist: The portals.
total_countnumber: How many portals there are in all, when Zoho says.

Example output

{
  "count": 1,
  "has_more": false,
  "page": 1,
  "per_page": 200,
  "portals": [
    {
      "domain": "acme",
      "id": "2263000000002001",
      "is_default": true,
      "name": "Acme Events",
      "owner_email": "owner@example.com",
      "owner_name": "Ola Owner"
    }
  ],
  "total_count": 1
}

List sessions

List the sessions on an event's agenda, optionally for one day.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Daydaynumber: Optional. Only this day of the event, counting from 1.At least 1.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

countnumber: How many sessions are in this answer.
has_moretrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho pages the list.
per_pagenumber: The page size, when Zoho pages the list.
sessionslist: The sessions.
total_countnumber: How many sessions there are in all, when Zoho says.

Example output

{
  "count": 1,
  "has_more": false,
  "page": 1,
  "per_page": 200,
  "sessions": [
    {
      "duration": 30,
      "featured": false,
      "hidden": false,
      "id": "2263000000014001",
      "session_type": "KEYNOTE",
      "speakers": [
        {
          "company": "Acme",
          "country": "US",
          "designation": "CTO",
          "email": "speaker@example.com",
          "featured": false,
          "first_name": "Sam",
          "id": "2263000000013001",
          "last_name": "Speaker",
          "status": 0,
          "status_string": "invited"
        }
      ],
      "start_time": "2026-11-04T15:00:00Z",
      "title": "Opening keynote",
      "track": "2263000000011021"
    }
  ],
  "total_count": 1
}

List speakers

List an event's speakers.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

countnumber: How many speakers are in this answer.
has_moretrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho pages the list.
per_pagenumber: The page size, when Zoho pages the list.
speakerslist: The speakers.
total_countnumber: How many speakers there are in all, when Zoho says.

Example output

{
  "count": 1,
  "has_more": false,
  "page": 1,
  "per_page": 200,
  "speakers": [
    {
      "company": "Acme",
      "country": "US",
      "designation": "CTO",
      "email": "speaker@example.com",
      "featured": false,
      "first_name": "Sam",
      "id": "2263000000013001",
      "last_name": "Speaker",
      "status": 0,
      "status_string": "invited"
    }
  ],
  "total_count": 1
}

List ticket classes

List an event's ticket classes, with prices and how many are sold.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Pagepagenumber: Optional. Which page of results to return, starting at 1.At least 1.
Page sizeper_pagenumber: Optional. How many to return per page, 1 to 200. Zoho's default is 200.From 1 to 200.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

countnumber: How many ticket classes are in this answer.
has_moretrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho pages the list.
per_pagenumber: The page size, when Zoho pages the list.
ticket_classeslist: The ticket classes.
total_countnumber: How many ticket classes there are in all, when Zoho says.

Example output

{
  "count": 1,
  "has_more": false,
  "page": 1,
  "per_page": 200,
  "ticket_classes": [
    {
      "amount": 0,
      "currency_code": "USD",
      "id": "2263000000011031",
      "name": "General admission",
      "quantity": 100,
      "sold": 1,
      "status": 0,
      "status_string": "active"
    }
  ],
  "total_count": 1
}

List tracks

List the tracks of an event's agenda. A session belongs to one.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

countnumber: How many tracks are in this answer.
has_moretrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho pages the list.
per_pagenumber: The page size, when Zoho pages the list.
total_countnumber: How many tracks there are in all, when Zoho says.
trackslist: The tracks.

Example output

{
  "count": 1,
  "has_more": false,
  "page": 1,
  "per_page": 200,
  "total_count": 1,
  "tracks": [
    {
      "index": 1,
      "language": "en",
      "name": "Main track",
      "track_id": "2263000000011021"
    }
  ]
}

Update an event

Change an event's name, time zone, dates or details. Fields left blank keep their current values.

Inputs

Eventevent_idtextRequired: The event. Pick one, or enter an event id from 'List events' or 'Create an event'.
Namenametext: The event's name. Leave blank to keep the current one.
Time zonetimezonetext: The event's time zone. Leave blank to keep the current one.One of: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, and 544 more.
Startsstart_timedate and time: When the event starts. Leave blank to keep the current one.
Endsend_timedate and time: When the event ends. The Free plan allows one event day. Leave blank to keep the current one.
Languagelanguagetext: Optional. The event's language code, such as en. Leave blank to keep the current one.
Summarysummarytext: Optional. A short summary. Leave blank to keep the current one.
Descriptiondescriptiontext: Optional. The full description; HTML is allowed. Leave blank to keep the current one.
Categorycategorytext: Optional. The event's category, such as Sales. Leave blank to keep the current one.
Portalportal_idtext: Optional. The Backstage portal to use. Leave blank for your default portal.

Outputs

A Zoho Backstage event.

categorytext: The event's category.
created_byobject: A Backstage user.
created_timetext: When it was created.
descriptiontext: The event's description (HTML).
end_timetext: When it ends, in UTC.
event_typenumber: 2 venue, 3 online, 4 hybrid.
event_type_stringtext: The event type as text.
idtext: The event's id.
languagetext: The event's language code, e.g. en.
last_modified_byobject: A Backstage user.
last_modified_timetext: When it was last changed.
nametext: The event's name.
spaceobject: The event's space.
start_timetext: When it starts, in UTC, e.g. 2026-11-04T09:00:00Z.
statusnumber: 0 unpublished, 1 published, 2 running, 3 completed, 4 canceled.
status_stringtext: The status as text, e.g. unpublished.
summarytext: A short summary.
tagslist: The event's tags.
thumbnail_urltext: The event's thumbnail image.
timezonetext: The event's IANA time zone, e.g. America/New_York.
venueobject: Where the event takes place.
website_urltext: The event website's address.

Example output

{
  "category": "Sales",
  "created_by": {
    "company": "Acme",
    "designation": "Organizer",
    "email": "owner@example.com",
    "first_name": "Ola",
    "id": "2263000000002003"
  },
  "created_time": "2026-10-01T09:00:00Z",
  "description": "<p>Our yearly summit.</p>",
  "end_time": "2026-11-04T22:00:00Z",
  "event_type": 3,
  "event_type_string": "online",
  "id": "2263000000011005",
  "language": "en",
  "last_modified_by": {
    "company": "Acme",
    "designation": "Organizer",
    "email": "owner@example.com",
    "first_name": "Ola",
    "id": "2263000000002003"
  },
  "last_modified_time": "2026-10-01T09:00:00Z",
  "name": "Customer Summit",
  "space": {
    "id": "2263000000011001"
  },
  "start_time": "2026-11-04T14:00:00Z",
  "status": 0,
  "status_string": "unpublished",
  "summary": "Our yearly summit.",
  "tags": [],
  "timezone": "America/New_York",
  "website_url": "https://example.zohobackstage.com/CustomerSummit"
}

ActionsCopy Anchor Link

Add a speakerCopy Anchor Link

Inputs

Outputs

Create a sessionCopy Anchor Link

Inputs

Outputs

Create an eventCopy Anchor Link

Inputs

Outputs

Create an orderCopy Anchor Link

Inputs

Outputs

Delete an eventCopy Anchor Link

Inputs

Outputs

Get a sessionCopy Anchor Link

Inputs

Outputs

Get a speakerCopy Anchor Link

Inputs

Outputs

Get an attendeeCopy Anchor Link

Inputs

Outputs

Get an eventCopy Anchor Link

Inputs

Outputs

Get an orderCopy Anchor Link

Inputs

Outputs

List attendeesCopy Anchor Link

Inputs

Outputs

List event membersCopy Anchor Link

Inputs

Outputs

List eventsCopy Anchor Link

Inputs

Outputs

List ordersCopy Anchor Link

Inputs

Outputs

List portalsCopy Anchor Link

Inputs

Outputs

List sessionsCopy Anchor Link

Inputs

Outputs

List speakersCopy Anchor Link

Inputs

Outputs

List ticket classesCopy Anchor Link

Inputs

Outputs

List tracksCopy Anchor Link

Inputs

Outputs

Update an eventCopy Anchor Link

Inputs

Outputs

On this page

Actions

Add a speaker

Create a session

Create an event

Create an order

Delete an event

Get a session

Get a speaker

Get an attendee

Get an event

Get an order

List attendees

List event members

List events

List orders

List portals

List sessions

List speakers

List ticket classes

List tracks

Update an event