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
  • capacity integer: The maximum number of people who can attend
  • 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
  • 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})

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

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

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)

Discount

A discount code for an event, that when given during the order flow, takes money off of one or more ticket types.

The discount can be a fixed reduction or a percentage reduction.

Fields

  • code string: The discount code itself
  • amount_off currency: The fixed amount of money to remove. Not set if percent_off is set.
  • percent_off string: The percentage discount to give. Not set if amount_off is set.
  • ticket_ids list of string: List of ticket IDs to apply discount to, or null if it applies to all tickets.
  • quantity_available integer: The maximum number of uses (optional)
  • quantity_sold integer: The current number of uses
  • start_date timestamp: The time when the discount code is valid from (optional)
  • end_date timestamp: The time when the discount code is valid to (optional)

Expansions

  • event from event_id event: The event this attendee is attending

Access Code

An access code which reveals one or more previously-hidden tickets when given during the order flow.

Fields

  • code string: The access code itself
  • ticket_ids list of string: List of ticket IDs to apply discount to, or null if it applies to all tickets.
  • quantity_available integer: The maximum number of uses (optional)
  • start_date timestamp: The time when the discount code is valid from (optional)
  • end_date timestamp: The time when the discount code is valid to (optional)

Expansions

  • event from event_id event: The event this attendee is attending

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.