Get specific ticket classes

The Get a Specific Ticket Class API allows users to retrieve detailed information about a specific ticket class by providing the ticket_class_id for their event within their Zoho Backstage account. Users must also provide portal_id and event_id to access this information, which uniquely identifies the portal and the event.
 

Header   

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
 

OAuth Scope   

zohobackstage.eventticket.READ
 

Path Parameters   

• portal_id (Long Integer)
  The unique identifier of the portal from which you want to retrieve the ticket class details. For example, "portal_id": "19593237" specifies the portal with ID 19593237.
• event_id (Long Integer)
  The unique identifier of the event for which you want to retrieve ticket class details. For example, "event_id": "3000000000022" specifies the event with ID 3000000000022.
• ticket_class_id (Long Integer)
  The unique identifier of the specific ticket class for which you want to retrieve details.For example, "ticket_class_id": "20000000222160" specifies the ticket class with ID 20000000222160.

 Response Structure and Field Explanations   

The response provides a JSON object containing detailed information about the specified ticket class. Below are the fields included in the response, along with explanations:

• id (Long Integer)
  The unique identifier assigned to the ticket class. For example, "id": "20000000222160" identifies the ticket class with ID 20000000222160.

• ticket_class_type (Integer)
  The type of ticket class. Possible values include:

  • 0 - Free

  • 1 - Paid

• ticket_class_type_string (String)
  A textual representation of the ticket class type. For example, "ticket_class_type_string": "free" indicates a free ticket class.
• quantity (Integer)
  The total quantity of tickets available. For example, "quantity": "100" specifies that 100 tickets are available.
• sold (Integer)
  The total quantity of tickets sold. For example, "sold": "2" indicates that 2 tickets have been sold.
• sales_start_date (String)
  The date and time when ticket sales begin, in UTC format. For example, "sales_start_date": "2024-04-04T07:57:16Z" specifies the sales start date and time.
• sales_end_date (String)
  The date and time when ticket sales end, in UTC format. For example, "sales_end_date": "2024-10-05T11:30:00Z" specifies the sales end date and time.
• hidden (Boolean)
  A flag indicating whether the ticket class is hidden. For example, "hidden": false means the ticket class is not hidden.
• minimum_buying_limit (Integer)
  The minimum buying limit for the ticket. For example, "minimum_buying_limit": 1 specifies that a minimum of 1 ticket can be bought.
• maximum_buying_limit (Integer)
  The maximum buying limit for the ticket. For example, "maximum_buying_limit": 10 specifies that a maximum of 10 tickets can be bought.
• featured (Boolean)
  A flag indicating whether the ticket class is featured. For example, "featured": false means the ticket class is not featured.
• status (Integer)
  The status of the ticket class. Possible values include:

  • 0 - Active

  • 1 - Deleted

  • 2 - Closed

  • 3 - Abandoned

  • 4 - Sold Out

• status_string (String)
  A textual representation of the ticket class status. For example, "status_string": "active" indicates the ticket class is active.
• attend_mode (Integer)
  The mode of attendance. Possible values include:

  • 0 - Both

  • 1 - Venue

  • 2 - Online

• attend_mode_string (String)
  A textual representation of the mode of attendance. For example, "attend_mode_string": "venue" indicates the ticket class is for venue attendance.
• amount (Number)
  The price of the ticket. For example, "amount": "0" indicates a free ticket.
• currency_code (String)
  The currency code for the ticket price. For example, "currency_code": "USD" specifies that the ticket price is in USD.
• language (String)
  The default language of the ticket class. For example, "language": "en" specifies English.
• name (String)
  The name of the ticket class. For example, "name": "Free" is the name of the ticket class.
• description (String)
  A description of the ticket class. For example, "description": null indicates no description is provided.
• created_by (Object)
  An object containing details about the creator of the ticket class.
  • id (Long Integer)
    The unique identifier of the creator. For example, "id": "20000000000001" identifies the creator with ID 20000000000001.
  • email (String)
    The email of the creator. For example, "email": "sam@zoho.com" is the creator's email.
  • first_name (String)
    The first name of the creator. For example, "first_name": "sam" is the creator's name.
  • company (String)
    The company of the creator. For example, "company": "Zoho" is the creator's company.
  • designation (String)
    The designation of the creator. For example, "designation": "Manager" is the creator's designation.
• last_modified_by (Object)
  An object containing details about the last modifier of the ticket class.
  • id (Long Integer)
    The unique identifier of the last modifier. For example, "id": "20000000000001" identifies the last modifier with ID 20000000000001.
  • email (String)
    The email of the last modifier. For example, "email": "sam@zoho.com" is the last modifier's email.
  • first_name (String)
    The first name of the last modifier. For example, "first_name": "sam" is the last modifier's name.
  • company (String)
    The company of the last modifier. For example, "company": "Zoho" is the modifier's company.
  • designation (String)
    The designation of the last modifier. For example, "designation": "Manager" is the modifier's designation.