Skip Main Navigation
Page Content

Event

Event

Event is an object representing anything from a small birthday party to a massive stadium concert and everything in between.

Events have to be owned by precisely one organiser, but have a lot of fields that are only present if certain options are turned on (for example, they can only have a password set if they are also not listed).

Public Fields

  • name multipart-text: The event’s name
  • description multipart-text: The event’s description (contents of the event page). May be long and have significant formatting. (optional)
  • url string: The URL to the event page for this event on Eventbrite
  • start datetime-tz: The start time of the event
  • end datetime-tz: The end time of the event
  • created datetime: When the event was created
  • changed datetime: When the event was last changed
  • status string: One of canceled, live, started, ended, completed
  • currency string: The ISO 4217 currency code for this event
  • online_event boolean: If this event doesn’t have a venue and is only held online

Public Expansions

  • logo from logo_id image: The image logo for this event (optional)
  • venue from venue_id venue: The venue the event is held at (optional)
  • organizer from organizer_id organizer: The organizer of the event
  • format from format_id format: The event’s format (type of event: conference, seminar, concert, etc.) (optional)
  • category from category_id category: The event’s category (technology, music, science, etc.) (optional)
  • subcategory from subcategory_id subcategory: The event’s subcategory (optional)
  • bookmark_info bookmark_info: The bookmark information on the event. Currently returns a dictionary with the number of users who have bookmarked the event as ‘count’ (i.e. {'count': 3})
  • refund_policy from refund_policy refund_policy: The event’s refund policy (optional).
  • ticket_availability ticket_availability: Additional data about general tickets information (optional).

Private Fields

Only shown to people with event owner permission.

  • listed boolean: If this event is publicly searchable on Eventbrite
  • shareable boolean: If this event shows social sharing buttons
  • invite_only boolean: If only people with invites can see the event page
  • show_remaining boolean: If the event page should show the number of tickets left
  • password string: The event password
  • capacity integer: The maximum number of people who can attend. DEPRECATED capacity will become a private field on or after May 15th, 2018
  • capacity_is_custom boolean: If True, the value of capacity is a custom-set value; if False, it’s a calculated value of the total of all ticket capacities. DEPRECATED capacity_is_custom will become a private field on or after May 15th, 2018

Ticket Class

This is an object representing one of the possible ticket classes (types of ticket) for an event.

Attendees can typically buy multiple different types of ticket in one transaction, and they may not necessarily map directly to an attendee per ticket (for example, attendees might buy multiple tickets for different days).

Tickets come in three types:

  • Free: These tickets have no cost or currency. If an event is all free tickets then it’s a free event and doesn’t need payout information.
  • Paid: This has an associated cost in the event’s currency (set on the event, but duplicated here as the return value is a currency type).
  • Donation: The user will be prompted to enter their own amount to donate on checkout. There is no fixed cost on the donation type.

Tickets may also have the fees set as included in the displayed price to the user or split one or both fees out into a visibly separate cost (this is purely an organiser choice about how they wish to communicate price).

Ticket class responses that are not from events you own will just have cost and fee set - these are the cost and fee displayed to the user on the ticket purchase page. Results from events you do own will additionally have actual_cost and actual_fee, which are the underlying amount of the ticket that you will get paid (actual_cost) and the actual fee Eventbrite takes from the user’s total charged amount (actual_fee).

Public Fields

  • name string: The ticket class’ name
  • description string: The ticket’s description. (optional)
  • cost currency: The display cost of the ticket (paid only)
  • fee currency: The display fee of the ticket (paid only)
  • donation boolean: If the ticket is a donation
  • free boolean: If the ticket is a free ticket
  • minimum_quantity integer: Minimum number that can be bought per order
  • maximum_quantity integer: Maximum number that can be bought per order
  • has_pdf_ticket boolean: If the attendes will get an order confirmation in PDF.
  • delivery_methods list: The list of delivery methods enabled for this ticket. Possible values include: [‘electronic’, ‘will_call’, ‘standard_shipping’]

Public Expansions

  • event from event_id event: The event the ticket class is for

Private Fields

Only shown to people with event owner permission.

  • quantity_total integer: How many of these tickets are available to be sold overall
  • quantity_sold integer: How many of these tickets have already been sold and confirmed (does not include tickets being checked out right now)
  • hidden boolean: If the ticket is hidden from the public
  • sales_start datetime: When sales for this ticket start
  • sales_end datetime: When sales for this ticket end
  • sales_start_after string: The ID of another ticket class that, when it sells out, will trigger sales of this class to start.
  • include_fee boolean: If the fee should be included in the displayed cost (cannot be set along with split_fee)
  • split_fee boolean: If the payment fee should be included in the displayed cost and the eventbrite fee is shown separately
  • hide_description boolean: If the description should be hidden on the event page (will remove description from public responses too)
  • auto_hide boolean: If the ticket should be hidden when not on sale
  • auto_hide_before datetime: Override the time at which auto hide disables itself to show the ticket (otherwise it’s sales_start)
  • auto_hide_after datetime: Override the time at which auto hide enables itself to re-hide the ticket (otherwise it’s sales_end)
  • order_confirmation_message string: Confirmation message displayed on order completion.

Cross Event Discount

Cross Event Discount is an object representing a discount that a ticket buyer can use. The term “Cross” refers to the fact that this kind of discount can be applied to many events at the same time.

There are four types of discounts:

  • Public Discounts, that any user can see on the listing or checkout pages. Only applied to single event discounts.
  • Coded Discounts, that requires the user to provide a secret code in order to enable them.
  • Access Codes, that allow the user to access hidden tickets, but cannot provide a discount.
  • Hold Discounts, that allow the user to unlock or apply discounts to seats defined as hold.

Fields

  • code string: The name of the discount (on public discounts) or the code that user should provide in order to activate it (on access codes or coded discounts).
  • type string: One of access, coded, public or hold, indicating the type of discount.
  • end_date local datetime: The code will be usable until this date.
  • end_date_relative integer: The code will be usable until this amount of seconds before the event start.
  • amount_off decimal: A fixed amount that is applied as a discount. It doesn’t have a currency, it depends on the event’s currency from 0.01 to 99999.99. Only two decimals are allowed. Will be null for an access code.
  • percent_off decimal: A percentage discount that will be applied on the ticket display price during the checkout, from 1.00 to 100.00. Only two decimals are allowed. Will be null for an access code.
  • quantity_available integer: The number of times this discount can be used, when 0 means “unlimited”.
  • quantity_sold integer: The number of times the discount was used. This is a display only field, it cannot be written.
  • start_date local datetime: The code will be usable since this date.
  • start_date_relative integer: The code will be usable since this amount of seconds before the event start.
  • ticket_class_ids list: On single event discounts, the list of IDs of tickets that are part of event_id for wich this discounts applies to. If empty, means “all the tickets of the event”.
  • event_id string: On single event discounts, the id of the Event this discount applies to. This is empty for cross event discounts.
  • ticket_group_id string: On cross event discounts, it is the id of the ticket group for which the discount applies to.
  • hold_ids list: List of IDs of holds this discount can unlock.

Expansions

  • event from event_id event: The Event for this discount (only for single event discounts).
  • ticket_group from ticket_group_id ticket_group: The Ticket Group for this discount (only for cross event discounts).

Ticket Group

The Ticket Group object allows the users to group an arbitrary number of ticket_class.

Fields

  • name string: Name of the ticket group. If it is greater than 20 characters will be truncated automatically.
  • status string: The status of the ticket group. One of transfer, live, deleted or archived. By default is live is not specified.
  • event_ticket_ids dict: A dictionary with the event ids and ticket ids, in the form {event_id: [ticket_id_1, ticket_id_2]}
  • tickets objectlist: The list of ticket class that includes the id, event_id, sales_channels, variants and name. Simplified version of ticket_class. By default is empty, unless the tickets expansion is used.

Category

An overarching category that an event falls into (vertical). Examples are “Music”, and “Endurance”.

Fields

  • name string: The category name
  • name_localized string: The category name localized to the current locale (if available)
  • short_name string: A shorter name for display in sidebars and other small spaces.
  • subcategories subcategory: List of subcategories, only shown on some endpoints.

Subcategory

A more specific category that an event falls into, sitting underneath a category.

Fields

  • name string: The category name
  • parent_category category: The category this belongs to

Format

A type of event presentation - e.g. “seminar”, “workshop”, “concert”. Separate from category as you can have a “music concert” or a “music seminar”.

Fields

  • name string: The format name
  • short_name string: A shorter name for display in sidebars and other small spaces.

Ticket buyer settings

Set of properties detailing the ticket buyer settings of an event

Fields

  • comfirmation_message multipart-text: Confirmation message to display on order completion.
  • instructions multipart-text: Instructions to display on the ticket.
  • refund_request_enabled boolean: Represents whether refund requests are accepted for the event.
  • redirect_url string: The url to redirect post-purchase. Will overwrite confirmation message.