Skip Main Navigation
Page Content

Events

For returning developers, you may notice that many of our endpoints now start with the ‘/organizations/:organization_id/’ path. This is a result of changes we made in the first half of 2018 to support users associated with multiple organizations on Eventbrite. Please visit our Organizations page for further context on this change.

GET /organizations/:id/events/

Returns a paginated response of events, under the key events, of all events the current user has access to in the specified organization.

Parameters

Name Type Required Description
name_filter string No Filter event results by name
currency_filter string No Filter event results by currency
order_by string No How to order the results (Valid choices are: start_asc, start_desc, created_asc, created_desc, name_asc, or name_desc)
show_series_parent boolean No True: Will show parent of a serie instead of children False: Will show children of a serie (Default value)
status string No Filter by events with a specific status set. This should be a comma delimited string of status. Valid status: all, draft, live, canceled, started, ended.
event_group_id string No Filter event results by event_group_id
page_size integer No Number of records in each page.
time_filter string No Limits results to either past or current & future events / orders. (Valid choices are: all, past, or current_future)
venue_filter list No Filter event results by venue IDs

Errors

  • INVALID

POST /organizations/:id/events/

Creates new events objects under an organization and returns it as event.

Parameters

Name Type Required Description
event.name.html string Yes The name of the event. Value cannot be empty nor whitespace.
event.description.html string No The description on the event page
event.organizer_id string No The ID of the organizer of this event
event.start.utc datetime Yes The start time of the event
event.start.timezone string Yes Start time timezone (Olson format)
event.end.utc datetime Yes The end time of the event
event.end.timezone string Yes End time timezone (Olson format)
event.hide_start_date boolean No Whether the start date should be hidden
event.hide_end_date boolean No Whether the end date should be hidden
event.currency string Yes Event currency (3 letter code)
event.venue_id string No ID of the venue
event.online_event boolean No Is the event online-only (no venue)?
event.listed boolean No If the event is publicly listed and searchable. Defaults to True.
event.logo.id string No (Deprecated) The logo for the event
event.logo_id string No The logo for the event
event.category_id string No The category (vertical) of the event
event.subcategory_id string No The subcategory of the event (US only)
event.format_id string No The format (general type) of the event
event.shareable boolean No If users can share the event on social media
event.invite_only boolean No Only invited users can see the event page
event.password string No Password needed to see the event in unlisted mode
event.capacity integer No Set specific capacity (if omitted, sums ticket capacities)
event.show_remaining boolean No If the remaining number of tickets is publicly visible on the event page
event.is_reserved_seating boolean No If the event is reserved seating
event.show_pick_a_seat boolean No For reserved seating event, if attendees can pick their seats.
event.show_seatmap_thumbnail boolean No For reserved seating event, if venue map thumbnail visible on the event page.
event.show_colors_in_seatmap_thumbnail boolean No For reserved seating event, if venue map thumbnail should have colors on the event page.
event.source string No Source of the event (defaults to API)

Errors

  • DATE_CONFLICT: Start date cannot be after end date.
  • DIFFERENT_TIMEZONES: You have passed different timezones for the start and end times (they must be the same)
  • INVALID_DATE: Start and end dates cannot be in the past.
  • INVENTORY_TYPE_CONFLICT: Only a single inventory type may be set at once.
  • INVITE_CONFLICT: You have set both listed and invite_only; these two options are mutually exclusive, and you are only allowed to set one.
  • NO_DEFAULT_ORGANIZER: The event does not have an organizer ID, and no default organizer could be found for the user.
  • NO_PACKAGE_SELECTED: You need to select a package to create an event. Go to /organizations/:id/assortment/ to select a package
  • NO_VENUE: You have attempted to create an event without a venue.
  • PASSWORD_CONFLICT: You have set both listed and password; these two options are mutually exclusive, and you are only allowed to set one.
  • SHARE_INVITE_CONFLICT: You have set both shareable and invite_only; these two options are mutually exclusive, and you are only allowed to set one.
  • UNSUPPORTED_TIMEZONE: The time zone for the start and end times does not exist.
  • VENUE_AND_ONLINE: You have set both online_event and venue_id; an event can event can either have a venue or be online, but not both at the same time.

GET /events/:id/

Returns an event for the specified event. Many of Eventbrite’s API use cases revolve around pulling details of a specific event within an Eventbrite account. Does not support fetching a repeating event series parent (see GET /series/:id/).

Parameters

Takes no parameters

Errors

No endpoint-specific errors

POST /events/:id/

Updates an event. Returns an event for the specified event. Does not support updating a repeating event series parent (see POST /series/:id/).

Parameters

Name Type Required Description
event.name.html string No The name of the event. Value cannot be empty nor whitespace.
event.description.html string No The description on the event page
event.organizer_id string No The ID of the organizer of this event
event.start.utc datetime No The start time of the event
event.start.timezone string No Start time timezone (Olson format)
event.end.utc datetime No The end time of the event
event.end.timezone string No End time timezone (Olson format)
event.hide_start_date boolean No Whether the start date should be hidden
event.hide_end_date boolean No Whether the end date should be hidden
event.currency string No Event currency (3 letter code)
event.venue_id string No ID of the venue
event.online_event boolean No Is the event online-only (no venue)?
event.listed boolean No If the event is publicly listed and searchable. Defaults to True.
event.logo.id string No (Deprecated) The logo for the event
event.logo_id string No The logo for the event
event.category_id string No The category (vertical) of the event
event.subcategory_id string No The subcategory of the event (US only)
event.format_id string No The format (general type) of the event
event.shareable boolean No If users can share the event on social media
event.invite_only boolean No Only invited users can see the event page
event.password string No Password needed to see the event in unlisted mode
event.capacity integer No Set specific capacity (if omitted, sums ticket capacities)
event.show_remaining boolean No If the remaining number of tickets is publicly visible on the event page
event.is_reserved_seating boolean No If the event is reserved seating
event.show_pick_a_seat boolean No For reserved seating event, if attendees can pick their seats.
event.show_seatmap_thumbnail boolean No For reserved seating event, if venue map thumbnail visible on the event page.
event.show_colors_in_seatmap_thumbnail boolean No For reserved seating event, if venue map thumbnail should have colors on the event page.
event.source string No Source of the event (defaults to API)

Errors

  • CANNOT_UPDATE_CURRENCY: Cannot update event with paid sales or reserved seats.
  • CANNOT_UPDATE_EXTERNALLY_TICKETED: Cannot update to externally ticketed.
  • CANNOT_UPDATE_RESERVED_SEATING: Cannot update to reserved seating.
  • CANNOT_UPDATE_SOURCE: An event’s source can only be set during creation.
  • DATE_CONFLICT: End date must be after start date.
  • DATE_CONFLICT: Start date cannot be after end date.
  • DIFFERENT_TIMEZONES: You have passed different timezones for the start and end times (they must be the same)
  • INVALID_DATE: Start and end dates cannot be in the past.
  • INVENTORY_TYPE_CONFLICT: Only a single inventory type may be set at once.
  • INVITE_CONFLICT: You have set both listed and invite_only; these two options are mutually exclusive, and you are only allowed to set one.
  • NO_DEFAULT_ORGANIZER: The event does not have an organizer ID, and no default organizer could be found for the user.
  • NO_PAYMENT_OPTIONS: This event has paid tickets but no payment options configured.
  • NO_VENUE: You have attempted to update an event without a venue.
  • PASSWORD_CONFLICT: You have set both listed and password; these two options are mutually exclusive, and you are only allowed to set one.
  • PAYMENT_OPTIONS_DEPRECATED_SPLIT_FEES: This event has split fees configured. Split fees are no longer supported, and you cannot create events with split fees enabled.
  • PAYMENT_OPTIONS_NO_COUNTRY: This event has paid tickets but no payment country configured.
  • PAYMENT_OPTIONS_NO_PAYMENT_TYPE: This event has paid tickets but no payment type configured.
  • PAYMENT_OPTIONS_PAYPAL_NO_EMAIL: This event has paid tickets and is configured to use PayPal, but no PayPal email address has been specified.
  • SHARE_INVITE_CONFLICT: You have set both shareable and invite_only; these two options are mutually exclusive, and you are only allowed to set one.
  • UNSUPPORTED_TIMEZONE: The time zone for the start and end times does not exist.
  • VENUE_AND_ONLINE: You have set both online_event and venue_id; an event can either have a venue or be online, but not both at the same time.

Argument Errors

  • event.end - CANNOT_CHANGE_DATES_FOR_ENDED_EVENT: You cannot change the end date for a completed event.
  • event.start - CANNOT_CHANGE_DATES_FOR_ENDED_EVENT: You cannot change the start date for a completed event.

POST /events/:id/publish/

Publishes an event if it has not already been deleted. In order for publish to be permitted, the event must have all necessary information, including a name and description, an organizer, at least one ticket, and valid payment options. This API endpoint will return argument errors for event fields that fail to validate the publish requirements. Returns a boolean indicating success or failure of the publish.

Parameters

Takes no parameters

Errors

  • ALREADY_PUBLISHED_OR_DELETED: This event has already been published or deleted.
  • NO_PAYMENT_OPTIONS: This event has paid tickets but no payment options configured.
  • PAYMENT_OPTIONS_DEPRECATED_SPLIT_FEES: This event has split fees configured. Split fees are no longer supported, and you cannot publish events with split fees enabled.
  • PAYMENT_OPTIONS_NO_COUNTRY: This event has paid tickets but no payment country configured.
  • PAYMENT_OPTIONS_NO_PAYMENT_TYPE: This event has paid tickets but no payment type configured.
  • PAYMENT_OPTIONS_PAYPAL_NO_EMAIL: This event has paid tickets and is configured to use PayPal, but no PayPal email address has been specified.
  • PUBLISH_FREE_EVENT_FEATURE_DENIED: You have reached your limit of free events in Professional.

Argument Errors

  • event.name - MISSING: Your event must have a name to be published.
  • event.start - MISSING: Your event must have a start date to be published.
  • event.end - MISSING: Your event must have an end date to be published.
  • event.start.timezone - MISSING: Your event start and end dates must have matching time zones to be published.
  • event.organizer - MISSING: Your event must have an organizer to be published.
  • event.currency - MISSING: Your event must have a currency to be published.
  • event.currency - INVALID: Your event must have a valid currency to be published.
  • event.tickets - MISSING: Your event must have at least one ticket to be published.
  • event.tickets.N.name - MISSING: All tickets must have names in order for your event to be published. The N will be the ticket class ID with the error.
  • event.tickets.N.quantity_total - MISSING: All non-donation tickets must have an available quantity value in order for your event to be published. The N will be the ticket class ID with the error.
  • event.tickets.N.cost - MISSING: All non-donation tickets must have a cost (which can be 0.00 for free tickets) in order for your event to be published. The N will be the ticket class ID with the error.

POST /events/:id/unpublish/

Unpublishes an event. In order for a free event to be unpublished, it must not have any pending or completed orders, even if the event is in the past. In order for a paid event to be unpublished, it must not have any pending or completed orders, unless the event has been completed and paid out. Returns a boolean indicating success or failure of the unpublish.

Parameters

Takes no parameters

Errors

  • CANNOT_UNPUBLISH: You have attempted to unpublish an event that has pending or completed sales of paid tickets (and that is not in the past, completed, and paid out), or has pending or completed sales of free tickets (ever).
  • NOT_PUBLISHED: This event is not currently published and cannot be unpublished.

POST /events/:id/cancel/

Cancels an event if it has not already been deleted. In order for cancel to be permitted, there must be no pending or completed orders. Returns a boolean indicating success or failure of the cancel.

Parameters

Takes no parameters

Errors

  • ALREADY_CANCELED: This event has already been canceled.
  • CANNOT_CANCEL: You have attempted to cancel an event that has pending or completed sales of paid tickets. The event cannot be canceled until all of these sales are refunded.

POST /events/:id/copy/

Creates a duplicate version of the event being copied. Returns the event object for the newly created event.

Parameters

Name Type Required Description
name string No The name of the new event
start_date datetime No The start time of the new event
end_date datetime No The end time of the new event
timezone string No timezone for the new event (Olson format)

Errors

  • INSUFFICIENT_PACKAGE: You need to upgrade your package to clone this event. Go to /users/:id/assortment/ to select a package
  • INVALID_END_DATE: An event end date must be between 1 minute(s) and 365 day(s) after the event start time.
  • INVALID_START_DATE: An event start date must be between now and 10 years from now.
  • UNABLE_TO_COPY_EVENT: We are currently unable to copy this event. Recovery from this error is not possible.
  • UNSUPPORTED_TIMEZONE: The timezone provided for start and end times is not supported.

DELETE /events/:id/

Deletes an event if the delete is permitted. In order for a delete to be permitted, there must be no pending or completed orders. Returns a boolean indicating success or failure of the delete.

Parameters

Takes no parameters

Errors

  • ALREADY_DELETED
  • CANNOT_DELETE

GET /events/:id/display_settings/

Retrieves the display settings for an event.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

POST /events/:id/display_settings/

Updates the display settings for an event.

Parameters

Name Type Required Description
display_settings.show_start_date boolean No Whether to display the start date on the event listing
display_settings.show_end_date boolean No Whether to display the end date on the event listing
display_settings.show_start_end_time boolean No Whether to display event start and end time on the event listing
display_settings.show_timezone boolean No Whether to display the event timezone on the event listing
display_settings.show_map boolean No Whether to display a map to the venue on the event listing
display_settings.show_remaining boolean No Whether to display the number of remaining tickets
display_settings.show_organizer_facebook boolean No Whether to display a link to the organizer’s Facebook profile
display_settings.show_organizer_twitter boolean No Whether to display a link to the organizer’s Twitter profile
display_settings.show_facebook_friends_going boolean No Whether to display which of the user’s Facebook friends are going
display_settings.terminology string No Which terminology should be used to refer to the event (Valid choices are: tickets_vertical, or endurance_vertical)

Errors

No endpoint-specific errors

GET /events/:id/ticket_classes/

Returns a paginated response with a key of ticket_classes, containing a list of ticket_class.

Parameters

Name Type Required Description
pos string No Only return ticket classes valid for the given point of sale (Valid choices are: online, or at_the_door)

Errors

No endpoint-specific errors

POST /events/:id/ticket_classes/

Creates a new ticket class, returning the result as a ticket_class under the key ticket_class.

Parameters

Name Type Required Description
ticket_class.name string Yes Name of this ticket type
ticket_class.description string No Description of the ticket
ticket_class.quantity_total integer No Total available number of this ticket, required for non-donation tickets
ticket_class.cost currency No Cost of the ticket (currently currency must match event currency) e.g. $45 would be ‘USD,4500’
ticket_class.donation boolean No Is this a donation? (user-supplied cost)
ticket_class.free boolean No Is this a free ticket?
ticket_class.include_fee boolean No Absorb the fee into the displayed cost
ticket_class.split_fee boolean No Absorb the payment fee, but show the eventbrite fee
ticket_class.hide_description boolean No Hide the ticket description on the event page
ticket_class.sales_channels list No A list of all supported sales channels ([“online”], [“online”, “atd”], [“atd”])
ticket_class.sales_start datetime No When the ticket is available for sale (leave empty for ‘when event published’)
ticket_class.sales_end datetime No When the ticket stops being on sale (leave empty for ‘one hour before event start’)
ticket_class.sales_start_after string No The ID of another ticket class - when it sells out, this class will go on sale.
ticket_class.minimum_quantity integer No Minimum number per order
ticket_class.maximum_quantity integer No Maximum number per order (blank for unlimited)
ticket_class.auto_hide boolean No Hide this ticket when it is not on sale
ticket_class.auto_hide_before datetime No Override reveal date for auto-hide
ticket_class.auto_hide_after datetime No Override re-hide date for auto-hide
ticket_class.hidden boolean No Hide this ticket
ticket_class.order_confirmation_message string No Order message per ticket type
ticket_class.delivery_methods list No A list of the available delivery methods for this ticket class

Errors

  • AUTO_HIDE_NOT_SET: You must select an auto hide setting.
  • BAD_QUANTITIES: The sum of tickets across ticket classes is not equal to the sum of total tickets available.
  • COST_GREATER_THAN_FEE: The cost of the ticket class must be greater than the fee.
  • CURRENCY_MISMATCH: Event currency ticket currency must match.
  • DONATION_AND_COST: A ticket cannot be a donation and a charged ticket.
  • DONATION_AND_FREE: A ticket cannot be a donation and a free ticket.
  • DONATION_AND_MIN_QUANTITY: Please set a minimum quantity for donation ticket.
  • FREE_AND_COST: A ticket cannot be a free ticket and a charged ticket.
  • INSUFFICIENT_PACKAGE: You need to upgrade your package to create more than one ticket. Go to /users/:id/assortment/ to select a package
  • INVALID_DELIVERY_METHOD: A ticket under this event organization cannot have this delivery method.
  • INVALID_EVENT: This event is not qualified to have tickets.
  • NO_COST: A price must be set for a charged ticket.
  • NO_QUANTITY_TOTAL: A quantity total must be set for this ticket.
  • SPLIT_AND_INCLUDE: You cannot split fees and include them in the price of the ticket.
  • SPLIT_FEES_DEPRECATED: This functionality is being deprecated.

GET /events/:id/ticket_classes/:ticket_class_id/

Gets and returns a single ticket_class by ID, as the key ticket_class.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

POST /events/:id/ticket_classes/:ticket_class_id/

Updates an existing ticket class, returning the updated result as a ticket_class under the key ticket_class.

Parameters

Name Type Required Description
ticket_class.name string No Name of this ticket type
ticket_class.description string No Description of the ticket
ticket_class.quantity_total integer No Total available number of this ticket, required for non-donation tickets
ticket_class.cost currency No Cost of the ticket (currently currency must match event currency) e.g. $45 would be ‘USD,4500’
ticket_class.donation boolean No Is this a donation? (user-supplied cost)
ticket_class.free boolean No Is this a free ticket?
ticket_class.include_fee boolean No Absorb the fee into the displayed cost
ticket_class.split_fee boolean No Absorb the payment fee, but show the eventbrite fee
ticket_class.hide_description boolean No Hide the ticket description on the event page
ticket_class.sales_channels list No A list of all supported sales channels ([“online”], [“online”, “atd”], [“atd”])
ticket_class.sales_start datetime No When the ticket is available for sale (leave empty for ‘when event published’)
ticket_class.sales_end datetime No When the ticket stops being on sale (leave empty for ‘one hour before event start’)
ticket_class.sales_start_after string No The ID of another ticket class - when it sells out, this class will go on sale.
ticket_class.minimum_quantity integer No Minimum number per order
ticket_class.maximum_quantity integer No Maximum number per order (blank for unlimited)
ticket_class.auto_hide boolean No Hide this ticket when it is not on sale
ticket_class.auto_hide_before datetime No Override reveal date for auto-hide
ticket_class.auto_hide_after datetime No Override re-hide date for auto-hide
ticket_class.hidden boolean No Hide this ticket
ticket_class.order_confirmation_message string No Order message per ticket type
ticket_class.delivery_methods list No A list of the available delivery methods for this ticket class

Errors

  • AUTO_HIDE_NOT_SET: You must select an auto hide setting.
  • BAD_QUANTITIES: The sum of tickets across ticket classes is not equal to the sum of total tickets available.
  • CANNOT_UPDATE_COST: Cannot change the ticket price after tickets have been sold
  • CIRCULAR_SALES_START_AFTER: Cannot start circular sales.
  • COST_GREATER_THAN_FEE: The cost of the ticket class must be greater than the fee.
  • CURRENCY_MISMATCH: Event currency ticket currency must match.
  • DONATION_AND_COST: A ticket cannot be a donation and a charged ticket.
  • DONATION_AND_FREE: A ticket cannot be a donation and a free ticket.
  • DONATION_AND_MIN_QUANTITY: Please set a minimum quantity for donation ticket.
  • FREE_AND_COST: A ticket cannot be a free ticket and a charged ticket.
  • INVALID_DELIVERY_METHOD: A ticket under this event organization cannot have this delivery method.
  • INVALID_EVENT: Create or update the ticket from the parent event instead.
  • INVALID_TICKET: Cannot update child ticket directly, update parent ticket rule instead.
  • NO_COST: A price must be set for a charged ticket.
  • NO_QUANTITY_TOTAL: A quantity total must be set for this ticket.
  • SPLIT_AND_INCLUDE: You cannot split fees and include them in the price of the ticket.
  • SPLIT_FEES_DEPRECATED: This functionality is being deprecated.

Argument Errors

  • sales_start_after - NO_DEPENDENT_TICKETS_FOR_SERIES: You cannot have dependent tickets for series events.

DELETE /events/:id/ticket_classes/:ticket_class_id/

Deletes the ticket class. Returns {"deleted": true}.

Parameters

Name Type Required Description
break_dependency boolean No Delete even if ticket sales depend on this ticket. This will start ticket sales of dependents immediately.

Errors

  • HAS_ATTENDEES
  • IS_STARTED_AFTER
  • LAST_TICKET

GET /events/:id/canned_questions/

This endpoint returns canned questions of a single event (examples: first name, last name, company, prefix, etc.). This endpoint will return question.

Parameters

Name Type Required Description
as_owner boolean No Return private events and more details

Errors

No endpoint-specific errors

POST /events/:id/canned_questions/

Creates a new canned question; returns the result as a question.

Parameters

Name Type Required Description
question.question.html string No Question displayed to the recipient
question.required boolean No Is an answer to this question required for registration?
question.type string No Type of Question (Valid choices are: checkbox, dropdown, text, paragraph, radio, or waiver)
question.respondent string Yes Ask this question to the ticket buyer or each attendee? (Valid choices are: ticket_buyer, or attendee)
question.waiver string No Waiver content for questions of type waiver
question.choices objectlist No
Choices for multiple choice questions. Format:
[{“answer”: {“html”: “Choice goes here...”}}, {“answer”: {“html”: “Another choice goes here...”}}]
question.ticket_classes objectlist No Tickets to which to limit this question. Format: [{“id”: “1234”}, {“id”: “4567”}]
question.parent_choice_id string No ID of Parent Question (for subquestions)
question.display_answer_on_order boolean No Is this question displayed on order confirmation?
question.canned_type string No String value of canned_type

Errors

  • INSUFFICIENT_PACKAGE: You need to upgrade your package to create a question.
  • NOT_ALLOWED

GET /events/:id/questions/

Eventbrite allows event organizers to add custom questions that attendees fill out upon registration. This endpoint can be helpful for determining what custom information is collected and available per event.

This endpoint will return question.

Parameters

Name Type Required Description
as_owner boolean No Return private events and more details

Errors

No endpoint-specific errors

POST /events/:id/questions/

Creates a new question; returns the result as a question as the key question.

field_error respondent INVALID
Respondent must match event survey type

Parameters

Name Type Required Description
question.question.html string No Question displayed to the recipient
question.required boolean No Is an answer to this question required for registration?
question.type string No Type of Question (Valid choices are: checkbox, dropdown, text, paragraph, radio, or waiver)
question.respondent string No Ask this question to the ticket buyer or each attendee? (Valid choices are: ticket_buyer, or attendee)
question.waiver string No Waiver content for questions of type waiver
question.choices objectlist No
Choices for multiple choice questions. Format:
[{“answer”: {“html”: “Choice goes here...”}}, {“answer”: {“html”: “Another choice goes here...”}}]
question.ticket_classes objectlist No Tickets to which to limit this question. Format: [{“id”: “1234”}, {“id”: “4567”}]
question.parent_id string No ID of Parent Question (for subquestions)
question.parent_choice_id string No ID of Parent Question Choice (for subquestions)
question.display_answer_on_order boolean No Is this question displayed on order confirmation?

Errors

  • INSUFFICIENT_PACKAGE: You need to upgrade your package to create a question. Go to /users/:id/assortment/ to select a package

GET /events/:id/questions/:id/

This endpoint will return question for a specific question id.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /events/:id/attendees/

Returns a paginated response with a key of attendees, containing a list of attendee.

Parameters

Name Type Required Description
status string No Limits results to either confirmed attendees or cancelled/refunded/etc. attendees (Valid choices are: attending, not_attending, or unpaid)
changed_since datetime No Only return attendees changed on or after the time given
last_item_seen integer No Only return attendees changed on or after the time given and with an id bigger than last item seen
attendee_ids list No Only return attendees whose ids are in this list

Errors

No endpoint-specific errors

GET /events/:id/attendees/:attendee_id/

Returns a single attendee by ID, as the key attendee.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /events/:id/orders/

Returns a paginated response with a key of orders, containing a list of order against this event.

Parameters

Name Type Required Description
status string No Filter to active (attending), inactive (not attending), all (both) orders and all_not_deleted (active and inactive but not deleted) (Valid choices are: active, inactive, all, or all_not_deleted)
changed_since datetime No Only return orders changed on or after the time given
last_item_seen integer No Only return orders changed on or after the time given and with an id bigger than last item seen
only_emails list No Only include orders placed by one of these emails
exclude_emails list No Don’t include orders placed by any of these emails
refund_request_statuses list No Return only orders with selected refund requests statuses. Possible values are: completed, pending, outside_policy, disputed, denied

Errors

No endpoint-specific errors

GET /events/:id/transfers/

Returns a list of transfers for the event.

Parameters

Name Type Required Description
changed_since datetime No Only return transfers changed on or after the time given

Errors

No endpoint-specific errors

GET /events/:id/teams/

Returns a list of attendee-team for the event.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /events/:id/teams/:id/

Returns information for a single attendee-team.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /events/:id/teams/:id/attendees/

Returns attendee for a single attendee-team.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /events/:event_id/ticket_groups/

Get the list of ticket_group for the event with the specified :event_id. By default, only the ticket groups that are live are shown.

To include the ticket class name and sales channel in the response, add the tickets expansion parameter: /events/:event_id/ticket_groups/?expand=tickets

Parameters

Name Type Required Description
status string No Limits results to groups with the specific status (Valid choices are: live, archived, deleted, or all)

Errors

No endpoint-specific errors

POST /events/:event_id/ticket_classes/:ticket_class_id/ticket_groups/:ticket_group_id/

Add the Ticket Class with the specified :ticket_class_id that belongs to the event with :event_id to the Ticket Group identified by :ticket_group_id.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

DELETE /events/:event_id/ticket_classes/:ticket_class_id/ticket_groups/:ticket_group_id/

Remove the Ticket Class with the specified :ticket_class_id that belongs to the event with :event_id from the Ticket Group identified by :ticket_group_id.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /events/:event_id/ticket_classes/:ticket_class_id/ticket_groups/

Get the Ticket Groups for Ticket Class with the specified :ticket_class_id that belongs to the event with :event_id. By default, only the ticket groups that are live are shown.

Parameters

Name Type Required Description
status string No Limits results to groups with the specific status (Valid choices are: live, archived, deleted, or all)

Errors

No endpoint-specific errors

GET /events/:id/ticket_buyer_settings/

Returns a ticket_buyer_settings for an event.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

Example:

GET /v3/events/:id/ticket_buyer_settings/
{
    "confirmation_message": {
        "text": "<H1>Confirmation Message</H1>",
        "html": "Confirmation Message"
    },
    "instructions": {
        "text": "<H1>Instructions</H1>",
        "html": "Instructions"
    },
    "event_id": "43253626762",
    "refund_request_enabled": true,
    "redirect_url": null
}

POST /events/:id/ticket_buyer_settings/

Updates the ticket buyer settings for an event. Returns a ticket_buyer_settings.

Parameters

Name Type Required Description
ticket_buyer_settings.confirmation_message.html string No Confirmation message to display on order completion
ticket_buyer_settings.refund_request_enabled boolean No Whether refund requests are accepted for the event
ticket_buyer_settings.instructions.html string No Instructions to display on the ticket
ticket_buyer_settings.redirect_url string No Redirect to this url post-purchase. Will overwrite confirmation message.

Errors

No endpoint-specific errors

Example:

POST /v3/events/:id/ticket_buyer_settings/

REQUEST_BODY
{
    "ticket_buyer_settings": {
        "confirmation_message": {
            "html": "<h1>Confirmation Message</h1>"
        },
        "instructions": {
            "html": "<h1>Instructions</h1>"
        },
        "refund_request_enabled": true
    }
}

RESPONSE
{
    "confirmation_message": {
        "text": "<H1>Confirmation Message</H1>",
        "html": "Confirmation Message"
    },
    "instructions": {
        "text": "<H1>Instructions</H1>",
        "html": "Instructions"
    },
    "event_id": "43253626762",
    "refund_request_enabled": true,
    "redirect_url": null
}

GET /organizations/:id/ticket_classes/

Returns a paginated response of ticket_class for the specified organization.

Parameters

Name Type Required Description
name_filter string No Search term to filter events and tickets by name.
event_id string No IDs of the event. Will search only ticket class of this event.
event_ids list No IDs of events. Will search ticket classes of these events.
status string No Filter by events with a specific status set. This should be a comma delimited string of status. Valid status: all, draft, live, canceled, started, ended.
from_cost_filter string No Filter the tickets having a cost higher than this value.
to_cost_filter string No Filter the tickets having a cost lower than this value.
sales_period_start_after datetime No Filter the tickets with sales starting after this date.
sales_period_end_before datetime No Filter the tickets with sales ending before this date.
visibility string No Filter the tickets matching this visibility status. (Valid choices are: ALL, HIDDEN, or VISIBLE)
order_by string No Order of the results. (Valid choices are: cost_asc, cost_desc, event_start_date_asc, type_asc, or type_desc)
time_filter string No Limits results to either past or current & future events / orders. (Valid choices are: all, past, or current_future)
page_size integer No Number of records in each page.
series_filter string No Filter that applies only to series events, returning either the childrens, parents, none or all the events/tickets. Valid values are: all, children, none, parents. If not present, defaults to children (Valid choices are: all, children, none, or parents)

Errors

  • INVALID_PARAMETER

POST /events/

Please use POST /organizations/:id/events/.

Warning

This endpoint is in the process of being deprecated.

Makes a new event, and returns an event for the specified event. Does not support the creation of repeating event series.

Parameters

Name Type Required Description
event.name.html string Yes The name of the event. Value cannot be empty nor whitespace.
event.description.html string No The description on the event page
event.organizer_id string No The ID of the organizer of this event
event.start.utc datetime Yes The start time of the event
event.start.timezone string Yes Start time timezone (Olson format)
event.end.utc datetime Yes The end time of the event
event.end.timezone string Yes End time timezone (Olson format)
event.hide_start_date boolean No Whether the start date should be hidden
event.hide_end_date boolean No Whether the end date should be hidden
event.currency string Yes Event currency (3 letter code)
event.venue_id string No The ID of a previously-created venue to associate with this event. You can omit this field or set it to null if you set online_event.
event.online_event boolean No Is the event online-only (no venue)?
event.listed boolean No If the event is publicly listed and searchable. Defaults to True.
event.logo.id string No (Deprecated) The logo for the event
event.logo_id string No The logo for the event
event.category_id string No The category (vertical) of the event
event.subcategory_id string No The subcategory of the event (US only)
event.format_id string No The format (general type) of the event
event.shareable boolean No If users can share the event on social media
event.invite_only boolean No Only invited users can see the event page
event.password string No Password needed to see the event in unlisted mode
event.capacity integer No Set specific capacity (if omitted, sums ticket capacities)
event.show_remaining boolean No If the remaining number of tickets is publicly visible on the event page
event.is_reserved_seating boolean No If the event is reserved seating
event.show_pick_a_seat boolean No For reserved seating event, if attendees can pick their seats.
event.show_seatmap_thumbnail boolean No For reserved seating event, if venue map thumbnail visible on the event page.
event.show_colors_in_seatmap_thumbnail boolean No For reserved seating event, if venue map thumbnail should have colors on the event page.
event.source string No Source of the event (defaults to API)

Errors

  • DATE_CONFLICT: Start date cannot be after end date.
  • DIFFERENT_TIMEZONES: You have passed different timezones for the start and end times (they must be the same)
  • INVALID_DATE: Start and end dates cannot be in the past.
  • INVENTORY_TYPE_CONFLICT: Only a single inventory type may be set at once.
  • INVITE_CONFLICT: You have set both listed and invite_only; these two options are mutually exclusive, and you are only allowed to set one.
  • NO_DEFAULT_ORGANIZER: The event does not have an organizer ID, and no default organizer could be found for the user.
  • NO_PACKAGE_SELECTED: You need to select a package to create an event. Go to /organizations/:id/assortment/ to select a package
  • NO_VENUE: You have attempted to create an event without a venue.
  • PASSWORD_CONFLICT: You have set both listed and password; these two options are mutually exclusive, and you are only allowed to set one.
  • SHARE_INVITE_CONFLICT: You have set both shareable and invite_only; these two options are mutually exclusive, and you are only allowed to set one.
  • UNSUPPORTED_TIMEZONE: The time zone for the start and end times does not exist.
  • VENUE_AND_ONLINE: You have set both online_event and venue_id; an event can event can either have a venue or be online, but not both at the same time.

GET /users/:id/owned_events/

Please use GET /organizations/:id/events/.

Warning

This endpoint is in the process of being deprecated.

Returns a paginated response of events, under the key events, of all events the user owns (i.e. events they are organising)

Parameters

Name Type Required Description
order_by string No How to order the results (Valid choices are: start_asc, start_desc, created_asc, created_desc, name_asc, or name_desc)
show_series_parent boolean No True: Will show parent of a serie instead of children False: Will show children of a serie (Default value)
status string No Filter by events with a specific status set. This should be a comma delimited string of status. Valid status: all, draft, live, canceled, started, ended.

Errors

No endpoint-specific errors

GET /users/:id/events/

Please use GET /organizations/:id/events/.

Warning

This endpoint is in the process of being deprecated.

Returns a paginated response of events, under the key events, of all events the user has access to

Parameters

Name Type Required Description
name_filter string No Filter event results by name
currency_filter string No Filter event results by currency
order_by string No How to order the results (Valid choices are: start_asc, start_desc, created_asc, created_desc, name_asc, or name_desc)
show_series_parent boolean No True: Will show parent of a serie instead of children False: Will show children of a serie (Default value)
status string No Filter by events with a specific status set. This should be a comma delimited string of status. Valid status: all, draft, live, canceled, started, ended.
event_group_id string No Filter event results by event_group_id
page_size integer No Number of records in each page.
time_filter string No Limits results to either past or current & future events / orders. (Valid choices are: all, past, or current_future)
venue_filter list No Filter event results by venue IDs

Errors

  • INVALID

POST /users/:id/events/

Please use POST /organizations/:id/events/.

Warning

This endpoint is in the process of being deprecated.

Creates new events objects under an user and returns it as event.

Parameters

Name Type Required Description
event.name.html string Yes The name of the event. Value cannot be empty nor whitespace.
event.description.html string No The description on the event page
event.organizer_id string No The ID of the organizer of this event
event.start.utc datetime Yes The start time of the event
event.start.timezone string Yes Start time timezone (Olson format)
event.end.utc datetime Yes The end time of the event
event.end.timezone string Yes End time timezone (Olson format)
event.hide_start_date boolean No Whether the start date should be hidden
event.hide_end_date boolean No Whether the end date should be hidden
event.currency string Yes Event currency (3 letter code)
event.venue_id string No ID of the venue
event.online_event boolean No Is the event online-only (no venue)?
event.listed boolean No If the event is publicly listed and searchable. Defaults to True.
event.logo.id string No (Deprecated) The logo for the event
event.logo_id string No The logo for the event
event.category_id string No The category (vertical) of the event
event.subcategory_id string No The subcategory of the event (US only)
event.format_id string No The format (general type) of the event
event.shareable boolean No If users can share the event on social media
event.invite_only boolean No Only invited users can see the event page
event.password string No Password needed to see the event in unlisted mode
event.capacity integer No Set specific capacity (if omitted, sums ticket capacities)
event.show_remaining boolean No If the remaining number of tickets is publicly visible on the event page
event.is_reserved_seating boolean No If the event is reserved seating
event.show_pick_a_seat boolean No For reserved seating event, if attendees can pick their seats.
event.show_seatmap_thumbnail boolean No For reserved seating event, if venue map thumbnail visible on the event page.
event.show_colors_in_seatmap_thumbnail boolean No For reserved seating event, if venue map thumbnail should have colors on the event page.
event.source string No Source of the event (defaults to API)

Errors

  • DATE_CONFLICT: Start date cannot be after end date.
  • DIFFERENT_TIMEZONES: You have passed different timezones for the start and end times (they must be the same)
  • INVALID_DATE: Start and end dates cannot be in the past.
  • INVENTORY_TYPE_CONFLICT: Only a single inventory type may be set at once.
  • INVITE_CONFLICT: You have set both listed and invite_only; these two options are mutually exclusive, and you are only allowed to set one.
  • NO_DEFAULT_ORGANIZER: The event does not have an organizer ID, and no default organizer could be found for the user.
  • NO_PACKAGE_SELECTED: You need to select a package to create an event. Go to /organizations/:id/assortment/ to select a package
  • NO_VENUE: You have attempted to create an event without a venue.
  • PASSWORD_CONFLICT: You have set both listed and password; these two options are mutually exclusive, and you are only allowed to set one.
  • SHARE_INVITE_CONFLICT: You have set both shareable and invite_only; these two options are mutually exclusive, and you are only allowed to set one.
  • UNSUPPORTED_TIMEZONE: The time zone for the start and end times does not exist.
  • VENUE_AND_ONLINE: You have set both online_event and venue_id; an event can event can either have a venue or be online, but not both at the same time.

GET /events/:id/discounts/

Please use https://www.eventbrite.com/developer/v3/endpoints/users/#ebapi-get-users-user-id-discounts

Warning

This endpoint is in the process of being deprecated.

POST /events/:id/discounts/

Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-post-discounts

Warning

This endpoint is in the process of being deprecated.

GET /events/:id/discounts/:discount_id/

Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-get-discounts-discount-id

Warning

This endpoint is in the process of being deprecated.

POST /events/:id/discounts/:discount_id/

Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-post-discounts-discount-id

Warning

This endpoint is in the process of being deprecated.

DELETE /events/:id/discounts/:discount_id/

Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-delete-discounts-discount-id

Warning

This endpoint is in the process of being deprecated.

GET /events/:id/public_discounts/

Please use https://www.eventbrite.com/developer/v3/endpoints/users/#ebapi-get-users-user-id-discounts

Warning

This endpoint is in the process of being deprecated.

POST /events/:id/public_discounts/

Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-post-discounts

Warning

This endpoint is in the process of being deprecated.

GET /events/:id/public_discounts/:discount_id/

Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-get-discounts-discount-id

Warning

This endpoint is in the process of being deprecated.

POST /events/:id/public_discounts/:discount_id/

Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-post-discounts-discount-id

Warning

This endpoint is in the process of being deprecated.

DELETE /events/:id/public_discounts/:discount_id/

Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-delete-discounts-discount-id

Warning

This endpoint is in the process of being deprecated.

GET /events/:id/access_codes/

Please use https://www.eventbrite.com/developer/v3/endpoints/users/#ebapi-get-users-user-id-discounts

Warning

This endpoint is in the process of being deprecated.

POST /events/:id/access_codes/

Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-post-discounts

Warning

This endpoint is in the process of being deprecated.

GET /events/:id/access_codes/:access_code_id/

Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-get-discounts-discount-id

Warning

This endpoint is in the process of being deprecated.

POST /events/:id/access_codes/:access_code_id/

Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-get-discounts-discount-id

Warning

This endpoint is in the process of being deprecated.

DELETE /events/:id/access_codes/

Please use https://www.eventbrite.com/developer/v3/endpoints/cross_event_discounts/#ebapi-delete-discounts-discount-id

Warning

This endpoint is in the process of being deprecated.

GET /users/:id/ticket_classes/

Please use GET /organizations/:id/ticket_classes/.

Warning

This endpoint is in the process of being deprecated.

Returns a paginated response of ticket_class for the specified user as user. This only support the currently authenticated user. You can use ‘me’ (/users/me/) as the alias for the current user id.

Parameters

Name Type Required Description
name_filter string No Search term to filter events and tickets by name.
event_id string No IDs of the event. Will search only ticket class of this event.
event_ids list No IDs of events. Will search ticket classes of these events.
status string No Filter by events with a specific status set. This should be a comma delimited string of status. Valid status: all, draft, live, canceled, started, ended.
from_cost_filter string No Filter the tickets having a cost higher than this value.
to_cost_filter string No Filter the tickets having a cost lower than this value.
sales_period_start_after datetime No Filter the tickets with sales starting after this date.
sales_period_end_before datetime No Filter the tickets with sales ending before this date.
visibility string No Filter the tickets matching this visibility status. (Valid choices are: ALL, HIDDEN, or VISIBLE)
order_by string No Order of the results. (Valid choices are: cost_asc, cost_desc, event_start_date_asc, type_asc, or type_desc)
time_filter string No Limits results to either past or current & future events / orders. (Valid choices are: all, past, or current_future)
page_size integer No Number of records in each page.
series_filter string No Filter that applies only to series events, returning either the childrens, parents, none or all the events/tickets. Valid values are: all, children, none, parents. If not present, defaults to children (Valid choices are: all, children, none, or parents)

Errors

  • INVALID_PARAMETER