API Reference

Get available ticketing details

This api is used to fetch available ticketing details with specified eventurl.
If we are passing accescode with this api, it will gives only those tickets which are accessible with specified access code.
It gives all the enabled tickets and add-on details as per the event URL.

Here is the description of response attributes, which returns in the form of JSON.

AttributesDescription
address This field shows the address of event, where it will be organized.
allowDisagreeDisclaimerConfirmation This field returns boolean type.
If it's true than user have permission to disagree disclaimer.
availableAccessCode This field returns true if access code is available for the tickets purchase.
categories It gives list of categories details.
color: it gives color name which is set with the specified category.
dataType: It will provide details of available datatypes in specified event like addon, ticket.
eventId: It will return unique value which is mapped with event, which we used in further api's.
havingVariations: This field return boolean data. It returns true if add-on have a multiple prices.
id: It will return unique category id.
imageUrl: It will return image url which is useful to display a image.
name: It will provide a info of category name.
position: It will return a double value which is useful to sort categories.
quantity: It will return a quantity of category.
discountCodeAvailable It will return true if discount code is available for ticket purchase.
endDate It will return event end date details.
eventCapacityReach It will provide true if event capacity is not reached.
eventFormat It will return event format detail.
eventKey It will return a unique id which is mapped with event.
eventListingStatus It will return event status.
eventVenueStatus It will provide a event venue status.
exitIntentPopupEnabled
hideRegistrationButton It will return true if admin wants to hide button on display page.
hideRemainingTickets Based on this flag user can hide show remaining tickets.
hideTicketPrice This flag provides detail for hide/show ticket price.
holderAttributeRequired
preEventAccessMinutes It will return time to show enter event button.
requireDisclaimerConfirmation It will return boolean, if it's value is true than attendees confirmation is required.
seatingChartKey It will return a seating key if admin have set allow seating.
startDate It will return event end date details.
stripeCountry It will return stripe account country which is mapped with event.
tickeTypes bundleType: It will provide a ticket bundle type e.g. INDIVIDUAL_TICKET, TABLE, SPONSOR or BLOCK.
categoryColor: It will return a category color.
categoryId: It will return a category id.
dataType: It will provide details of available datatypes in specified event like addon, ticket.
enableTicketDescription: If it's value true than ticket description will display.
endDate: It will provide a ticket type's end date.
fee: It will show the extra charges on the ticket amount.
maxTickerPerBuyer: It will provide a count, how many tickets user can buy at a time.
minTickerPerBuyer: It will provide a minimum count for ticket purchase.
name: It will provide a ticket name which is set by the event host to differentiate.
passFeesToBuyer: It will return true if fees amount pass to the buyers.
position: It will return a double value which is useful to sort categories.
price: It will return a ticket amount.
remaniningTickets: It will return available ticket count.
startDate: It will provide a ticket type's start date.
ticketType: It will return ticket type, if it's free or paid.
ticketTypeDescription: It will return a custom description for ticket type.
ticketsPerTable: It will return tickets count per table.
totalSoldTickets: It will return sold ticket count.
typeId: It will return a unique id of ticket type.
ticketingFee addon: false
aeFeeFlat: It will return amount of accelevent fee flat amount.
aeFeePercentage: It will return accelevent fee percentage.
creditCardProcessingFlat: It will return credit card processing fee flat charge.
creditCardProcessingPercentage: It will return credit card processing percentage flat charge.
fromThreshold: It will provide from ticket price threshold.
toThreshold: It will provide to ticket price threshold.
inPerson: It will return true/fasle.
operator: It will provide operator.
wlFeeFlat: It will return white label fee flat charge.
wlFeePercentage: It will return white label fee percentage.

Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error CodeError Description
4040200 No Event could be found
Language
Click Try It! to start a request and see the response here!