Eventbrite API Docs

Attendee

Retrieve an Attendee

Retrieve an Attendee by Attendee ID.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`attendee_id`	path	string	yes	Attendee ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

List Attendees by Event

List Attendees by Event ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`status`	query	string	no	Filter Attendees by status of either `attending`, `not attending` or `unpaid`.
`changed_since`	query	string	no	Filter Attendees changed on or after the specified time.
`last_item_seen`	query	string	no	When passed in conjunction with `changed_since`, filter Attendees changed on or after the specified time and with an ID later than the value of the`last_item_seen` field.
`attendee_ids`	query	string	no	Filter Attendees with the specified IDs. (e.g. `['',..]`)

Responses

Status	Description
`200`	200 response

List Attendees by Organization

List Attendees of an Organization's Events by Organization ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID. (e.g. `12345`)
`status`	query	string	no	Filter Attendees by status of either `attending` or `not_attending`.
`changed_since`	query	string	no	Filter Attendees by resource changed on or after the time given.

Responses

Status	Description
`200`	200 response

Balance

Remaining Balance

Given an organization id and an event id returns an event-level balance specific to the time the endpoint is called

Parameters

Name	In	Type	Required	Description
`public_organization_id`	query	string	yes	Public organization ID (e.g. `5130962065`)
`public_event_id`	query	string	yes	Public event ID (e.g. `751490729`)

Responses

Status	Description
`200`	200 response
`400`	400 response
`403`	403 response
`404`	404 response
`500`	500 response

Name	In	Type	Required	Description
`id`	path	string	yes	Category ID (e.g. `1234`)

Name	In	Type	Required	Description
`subcategory_id`	path	string	yes	Subcategory ID (e.g. `12345`)

Discount

Retrieve a Discount

Retrieve a Discount by Discount ID.

Parameters

Name	In	Type	Required	Description
`discount_id`	path	string	yes	Discount ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Update a Discount

Update a Discount by Discount ID.

Parameters

Name	In	Type	Required	Description
`discount_id`	path	string	yes	Discount ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Delete a Discount

Delete a Discount. Only unused Discounts can be deleted. <b>Warning:</b> A Discount cannot be restored after being deleted.

Parameters

Name	In	Type	Required	Description
`discount_id`	path	string	yes	Discount ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Create a Discount

Create a new Discount.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Search Discounts by Organization

List Discounts by Organization ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID. (e.g. `12345`)
`scope`	query	string	yes	Discount scope. (e.g. `[object Object]`)
`code_filter`	query	string	no	Filter Discounts by approximate match code or name.
`code`	query	string	no	Filter Discount by exact match code or name. (e.g. `abcde`)
`page_size`	query	string	no	Number of records to display on each returned page. (e.g. `1`)
`type`	query	string	no	Discount type.
`ticket_group_id`	query	string	no	Filter Discounts by Ticket Group ID. (e.g. `12345`)
`event_id`	query	string	no	Filter Discounts by Event ID. Required for the `event` scope. (e.g. `12345`)
`order_by`	query	string	no	Response order.
`hold_ids`	query	string	no	Filter discounts to only those that apply to specified hold IDs. IDs are in composite id format for either hold class (H123) or hold inventory tier (I123)

Responses

Status	Description
`200`	200 response
`400`	400 response

Display Settings

Retrieve Display Settings

Retrieve the Display Settings for an Event by Event ID.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Update Display Settings

Update Display Settings for an Event by Event ID.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Event Capacity

Retrieve a Capacity Tier

Retrieve the capacity tier for an event.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID (e.g. `5678`)

Responses

Status	Description
`200`	200 response
`403`	403 response
`404`	404 response

Update a Capacity Tier

Update the capacity tier for an event. Partial updates are supported. Submit only attributes that are changed. These rules must apply when updating capacity tier: - Sum of `quantity_total` from capacity holds cannot exceed remaining capacity quantity - If the event is already oversold, new remaining capacity quantity cannot become further negative (oversold) To **create GA capacity hold inventory tiers** for an event, include payload with `holds`. `capacity_total` must be supplied if event does not have a capacity set. For example: ```json { "capacity_total": 100, "holds": [ { "name": "Marketing", "quantity_total": 10, "sort_order": 1, }, ] } ``` To **update/delete GA capacity hold inventory tiers** for an event, include payload with `holds` that contain `id` and fields of the hold tier to be updated. Deleting is the same as updating with `is_deleted` set to `true`. Deleting a hold tier that has tickets sold or associated with attendees will be denied. `quantity_total` for a hold tier cannot be reduced below the quantity used (`quantity_sold` + `quantity_pending`). Payload can contain partial data/partial hold inventory tiers to be updated/deleted. For example: ```json { "holds": [ {"id": "I987", "name": "Marketing"}, # update existing tier {"id": "I988", "is_deleted": true}, # delete existing tier {"name": "Accounting", "quantity_total": 10}, # create new tier ] } ```

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID (e.g. `5678`)

Responses

Status	Description
`200`	200 response
`400`	400 response
`403`	403 response
`404`	404 response

Event Description

Retrieve Full HTML Description

Returns the fully rendered description for an Event as a string of HTML. This endpoint will work with events created using New or Classic Create. ```json { "description: <div>Example summary!<\/div>\n<div><P>My <EM>event's<\/EM> description would go <STRONG>here<\/STRONG>.<\/P><\/div>" } ``` #### Permissions `event.details:read`

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Event Schedule

Create an event schedule

Creating an event schedule requires that a series parent event has already been created. For instructions on how to create a series parent event, please refer to the [Create Event API](#ref-op-postOrganizationsOrganization_idEvents). Creating an event schedule will add occurrences to a series parent event, according to the pattern specified in the schedule. Each occurrence is backed by an [Event](#event_object), and will be associated with the series parent event specified in the request. If an occurrence specified by the schedule has the same date and time as an existing occurrence, the new occurrence is ignored and not created (the rest of the occurrences specified by the schedule are still created).

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. Must be a valid series parent event. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response
`403`	403 response

Event Search

Search Events - deprecated

List public Events from Eventbrite. Returns a paginated response. >**Notice:** Access to this API was shut down at 11:59 pm PT on Thursday, December 12, 2019. For more information regarding the shut down, refer to our [changelog](https://www.eventbrite.it/platform/docs/changelog).

Parameters

Name	In	Type	Required	Description
`q`	query	string	no	Return only those Events matching the given keyword(s). Accepts any string as a keyword.
`sort_by`	query	string	no	Sort order of list of Events. Prefix with a hyphen to reverse the sort order. (e.g. `[object Object]`)
`location.address`	query	string	no	The address of the location you want to search for Events around.
`location.within`	query	string	no	The distance you want to search around the given location. This should be an integer followed by “mi” or “km”.
`location.latitude`	query	string	no	The latitude of the location you want to search for Events around.
`location.longitude`	query	string	no	The longitude of the location you want to search for Events around.
`location.viewport.northeast.latitude`	query	string	no	The latitude of the northeast corner of a viewport.
`location.viewport.northeast.longitude`	query	string	no	The longitude of the northeast corner of a viewport.
`location.viewport.southwest.latitude`	query	string	no	The latitude of the southwest corner of a viewport.
`location.viewport.southwest.longitude`	query	string	no	The longitude of the southwest corner of a viewport.
`organizer.id`	query	string	no	Filter Events organized by the given Organizer ID.
`user.id`	query	string	no	Filter Events owned by the given User ID.
`categories`	query	string	no	Filter Events under the given category IDs. This should be a comma delimited string of category IDs
`subcategories`	query	string	no	Filter Events under the given subcategory IDs. This should be a comma delimited string of subcategory IDs.
`formats`	query	string	no	Filter Events with the given format IDs. This should be a comma delimited string of format IDs.
`price`	query	string	no	Filter Events that are “free” or “paid”. (e.g. `free`)
`start_date.range_start`	query	string	no	Filter Events with start dates after the given date.
`start_date.range_end`	query	string	no	Filter Events with start dates before the given date.
`start_date.keyword`	query	string	no	Filter Events with start dates within the given keyword date range. (e.g. `today`)
`date_modified.range_start`	query	string	no	Filter Events with modified dates after the given UTC date.
`date_modified.range_end`	query	string	no	Filter Events with modified dates before the given UTC date.
`date_modified.keyword`	query	string	no	Filter Events with modified dates within the given keyword date range. (e.g. `today`)
`search_type`	query	string	no	Use the preconfigured settings for this type of search - Current option is “promoted”. (e.g. `promoted`)
`include_all_series_instances`	query	string	no	Boolean for whether or not you want to see all instances of repeating Events in search results.
`include_unavailable_events`	query	string	no	Boolean for whether or not you want to see Events without tickets on sale.
`include_adult_events`	query	string	no	Boolean for whether or not you want to see Events with adult content.
`incorporate_user_affinities`	query	string	no	Incorporate additional information from the user’s historic preferences.
`high_affinity_categories`	query	string	no	Make search results prefer Events in these categories. This should be a comma delimited string of category IDs.

Responses

Status	Description
`200`	200 response

Event Series

Retrieve an Event Series

Retrieve the parent Event Series by Event Series ID.

Parameters

Name	In	Type	Required	Description
`event_series_id`	path	string	yes	Event Series ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Event Teams

List by Event

Returns a list of `teams` for the event. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	The event ID that the teams will be retrieved from. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Retrieve Team

Returns information for a single `team`.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	The event ID that the team will be retrieved from. (e.g. `12345`)
`team_id`	path	string	yes	The team ID that will be retrieved. (e.g. `1`)

Responses

Status	Description
`200`	200 response

List Attendees by Team

Returns `attendee` for a single `team`. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	The event ID that the team will be retrieved from. (e.g. `12345`)
`team_id`	path	string	yes	The team ID that will be retrieved. (e.g. `1`)

Responses

Status	Description
`200`	200 response

Create a Team

Create and returns a `team`.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	The event ID that the team will be created from. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Verify password for a team

Verify that the password of a team is correct, and if so, and returns the token of the team

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	The event ID of the team which the password will be checked (e.g. `12345`)
`team_id`	path	string	yes	The team ID which the password will be checked (e.g. `1`)

Responses

Status	Description
`200`	200 response

Search teams by name Team

Returns the teams of an event searched by name. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	The event ID from which we want to search teams (e.g. `12345`)
`term`	path	string	yes	Search term. (e.g. `team_search`)

Responses

Status	Description
`200`	200 response

Event

Retrieve an Event

Retrieve an Event by Event ID. > **Note**: If the Event being retrieved was created using the new version of Create, then you may notice that the Event’s description field is now being used to hold the event summary. To retrieve your event’s fully-rendered HTML description, you will need to make an additional API call to retrieve the Event's full HTML description.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Update an Event

Update Event by Event ID. Note that if the event is a series parent, updating `name`, `description`, `hide_start_date`, `hide_end_date`, `currency`, `show_remaining`, `password`, `capacity`, or `source` on the series parent will update these fields on all occurrences in the series.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Delete an Event

Delete an Event if the delete is permitted. Returns a boolean indicating the success or failure of the delete action. To delete an Event, the Event must not have any pending or completed orders. If the event is a series parent, all series occurrences must be in a valid state to be deleted. Deleting the series parent will delete all series occurrences.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Create an Event

Create a new Event. By default, this API creates an event that occurs once. In order to create a series of events with multiple occurrences (also known as a "repeating event" or "recurring event"), you must first create one event to serve as the "series parent", then add occurrences to the series parent. Creating the series parent is done by calling the Create Event API with the `is_series` attribute set to `True`. Occurrences can then be added to the newly created series parent, using the [Event Schedule API](#ref-op-postEventsEvent_idSchedules).

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	ID of the Organization that owns the Event. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

List Events by Organization

List Events by Organization ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID. (e.g. `1234`)
`name_filter`	query	string	no	Filter Organization's Events by specified name.
`currency_filter`	query	string	no	Filter Organization's Events by specified currency. (e.g. `USD`)
`order_by`	query	string	no	Sort order for the list of Events. (e.g. `[object Object]`)
`series_filter`	query	string	no	Filter based on whether an event is not a series, a series, child series or parent series. This filter has higher precedence than `show series parent` filter. Default will use `show series parent` filter behavior.
`show_series_parent`	query	string	no	false (Default) = In the list, show the series children and not series parent. true = In the list, show the series parent instead of series children. (e.g. `false`)
`status`	query	string	no	Filter Organization's Events by status. Specify multiple status values as a comma delimited string. (e.g. `[object Object]`)
`event_group_id`	query	string	no	Filter Organization's Events by event_group_id.
`collection_id`	query	string	no	Filter Organization's Events by collection_id.
`page_size`	query	string	no	Number of records to display on each page of the list. (e.g. `50`)
`time_filter`	query	string	no	Limits the list results to either past or current and future Events. (e.g. `[object Object]`)
`venue_filter`	query	string	no	Filter Organization's Events by Venue ID.
`organizer_filter`	query	string	no	Filter Organization's Events by Organizer ID.
`inventory_type_filter`	query	string	no	Filter Organization's Events by Inventory Type.
`event_ids_to_exclude`	query	string	no	IDs of events to exclude from the Organization's Events list. (e.g. `1234, 5678`)
`event_ids`	query	string	no	IDs of events to include from the Organization's Events list. (e.g. `1234, 5678`)
`collection_ids_to_exclude`	query	string	no	IDs of collections to exclude from the Organization's Events list. This will have precedence over `event_group_id` filter and `collection_id` filter. (e.g. `1234, 5678`)

Responses

Status	Description
`200`	200 response
`400`	400 response
`404`	404 response

List Events by Venue

List Events by Venue ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`venue_id`	path	string	yes	Venue ID. (e.g. `1234`)
`status`	query	string	no	Filter Events at the Venue by status. Specify multiple status values as a comma delimited string. (e.g. `[object Object]`)
`order_by`	query	string	no	Sort order of list of Events at the Venue. (e.g. `[object Object]`)
`start_date`	query	string	no	Filter Events at the Venue by a specified date range.
`only_public`	query	string	no	True = Filter public Events at the Venue. (e.g. `true`)

Responses

Status	Description
`200`	200 response

List Events by Series

List Events by Event Series ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`event_series_id`	path	string	yes	Event Series ID. (e.g. `12345`)
`time_filter`	query	string	no	Limits the list results to either past or current and future Events.
`order_by`	query	string	yes	Sort order for the list of Events.
`start_date.range_start`	query	string	no	Return only Events in the series past this date
`start_date.range_end`	query	string	no	Return only Events in the series before this date

Responses

Status	Description
`200`	200 response

Publish an Event

Publish an Event. 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. If the event is a series parent, all occurrences in the series must be in a valid state to be published. Publishing the series parent will publish all series occurrences. Deleted Events can not be published.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Unpublish an Event

Unpublish an Event. Returns a boolean indicating the success or failure of the unpublish action. To unpublish a free Event, including a past free Event, the Event must not have any pending or completed orders. A completed and paid out paid Event can be unpublished. A paid Event that is not completed and paid out can only be unpublished if the Event does not have any pending or completed orders. If the event is a series parent, all occurrences in the series must be in a valid state to be unpublished. Unpublishing a series parent will unpublish all series occurrences. A series occurrence cannot be unpublished individually.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Copy an Event

Copy the Event, creating a duplicate version of the Event with a new Event ID. Use to create a new Event based on an existing Event. Returns the Event object for the newly created Event. The Event payment options, payout method, refund policy, and tax settings will copy to the new Event.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Cancel an Event

Cancel an Event. Returns a boolean indicating the success or failure of the cancel action. To cancel an Event, the Event must not have any pending or completed orders. If the event is a series parent, all series occurrences must be in a valid state to be canceled. Canceling the series parent will cancel all series occurrences.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Formats

Retrieve a Format

Retrieve a Format by Format ID.

Parameters

Name	In	Type	Required	Description
`format_id`	path	string	yes	Format ID. (e.g. `2`)

Responses

Status	Description
`200`	200 response

List Formats

List all available Formats. Returns a paginated response.

Responses

Status	Description
`200`	200 response

Inventory Tiers

Retrieve an Inventory Tier

Retrieve an Inventory Tier by ID for an Event.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID (e.g. `5678`)
`inventory_tier_id`	path	string	yes	Inventory Tier ID (e.g. `1234`)

Responses

Status	Description
`200`	200 response
`403`	403 response
`404`	404 response

Update an Inventory Tier

Update an existing Inventory Iier by ID for an Event. Partial updates are supported. Submit only attributes that are changed.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID (e.g. `12345`)
`inventory_tier_id`	path	string	yes	Inventory Tier ID (e.g. `1234`)

Responses

Status	Description
`200`	200 response
`400`	400 response
`403`	403 response
`404`	404 response

Delete an Inventory Tier

Mark an existing Inventory Tier as deleted.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID (e.g. `12345`)
`inventory_tier_id`	path	string	yes	Inventory Tier ID (e.g. `1234`)

Responses

Status	Description
`200`	200 response
`400`	400 response
`403`	403 response
`404`	404 response

Update Multiple Inventory Tiers

Update multiple existing Inventory Tiers for an Event. Partial updates are supported. Submit only attributes that are changed.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response
`403`	403 response
`404`	404 response

List Inventory Tiers by Event

Retrieves inventory tiers for an event.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID (e.g. `1234`)
`seatmap_number`	query	string	no	When specified, output is filtered by this tier group (e.g. `1`)
`count_against_event_capacity`	query	string	no	If true, output is filtered by whether the tier counts toward the event capacity or not (e.g. `true`)

Responses

Status	Description
`200`	200 response
`403`	403 response
`404`	404 response

Media

Retrieve Media

Retrieve Media by Media ID.

Parameters

Name	In	Type	Required	Description
`media_id`	path	string	yes	Media ID. (e.g. `12345`)
`width`	query	string	no	Thumbnail width. (e.g. `10`)
`height`	query	string	no	Thumbnail height. (e.g. `15`)

Responses

Status	Description
`200`	200 response

Upload a Media File

Upload a Media image file.

Responses

Status	Description
`200`	200 response
`400`	400 response

Retrieve a Media Upload

Retrieve information on a Media image upload.

Responses

Status	Description
`200`	200 response

Order

Retrieve Order by ID

Retrieve an Order by Order ID.

Parameters

Name	In	Type	Required	Description
`order_id`	path	string	yes	Order ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

List Orders by Organization ID

Returns a paginated response of orders, under the key orders, of orders placed against any of the events the organization owns (events that would be returned from /organizations/:id/events/)

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID. (e.g. `12345`)
`status`	query	string	no	Filter Event's Order by status. (e.g. `[object Object]`)
`changed_since`	query	string	no	Only return orders changed on or after the time given.
`only_emails`	query	string	no	Only include orders placed by one of these emails.
`exclude_emails`	query	string	no	Don't include orders placed by any of these emails

Responses

Status	Description
`200`	200 response

List Orders by Event ID

List Orders by Event ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`status`	query	string	no	Filter Event's Order by status. (e.g. `[object Object]`)
`changed_since`	query	string	no	Orders changed on or after this time.
`last_item_seen`	query	string	no	Orders changed on or after this time, and with an ID larger than last item seen.
`only_emails`	query	string	no	Orders placed by this email address.
`exclude_emails`	query	string	no	Orders placed by this email address are not included in return.
`refund_request_statuses`	query	string	no	Only Orders with specified refund request status are included in return.

Responses

Status	Description
`200`	200 response

List Orders by User ID

List Orders by User ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`user_id`	path	string	yes	User ID. (e.g. `12345`)
`changed_since`	query	string	no	Order changed on or after this time.
`time_filter`	query	string	no	Filter the list to only, or all, past or current and future Orders.

Responses

Status	Description
`200`	200 response

Refund Order

orphan Fully refund an order

Parameters

Name	In	Type	Required	Description
`order_id`	path	string	yes	Order ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Get refund retention policy

orphan Check whether the Eventbrite service fee is retained for a refund of this order, for a given refund reason. Call this before issuing a refund (Refund Order) to decide whether to send `refund_retention_policy_strategy_code`: send it when `refund_retention_policy` is `enable_retain_fee`; when it is `no_retain_fee` the fee is refunded regardless of the parameter.

Parameters

Name	In	Type	Required	Description
`order_id`	path	string	yes	Order ID. (e.g. `12345`)
`refund_reason_code`	query	string	no	Refund reason to evaluate (same values as the Refund Order `reason` field). (e.g. `no_longer_able_to_attend`)
`total_refund_amount`	query	string	no	Refund amount. Pass for a partial refund; partial refunds do not retain the fee. (e.g. `10.00`)

Responses

Status	Description
`200`	200 response

Organizations Members

List Members of an Organization

List an Organization's Members by Organization ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Organization Roles

List Roles by Organization

List an Organization's Roles by Organization ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Organization

List your Organizations

List the Organizations to which you are a Member. Returns a paginated response.

Responses

Status	Description
`200`	200 response

List Organizations by User

List Organizations by User ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`user_id`	path	string	yes	User ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Pricing

Calculate Items

Calculates the Fees that Eventbrite would charge for a given price as it’s shown on the ticket authoring flow. This price would be hypothetical, as the pricing calculation would be based on the passed parameters instead of facts as it happens when an order is created. This price is a simplified view. The price reported can’t be used to calculate the price of an order. Its used to get fees, taxes and total price depending from scope parameter. The scope can be as one of the members: `organization`, `event`, `ticket_class` or `assortment_plan`. Depending on the scope type, the scope identifier has different meanings: For scope.type ``organization`` scope.identifier represents an organization id. For scope.type ``event`` scope.identifier represents an event id. For scope.type ``ticket_class`` scope.identifier represents a ticket class id. For scope.type ``assortment_plan`` scope.identifier can take a value of either 'package1' or 'package2' Returns a `item_pricing` according to the provided base price and scope.

Responses

Status	Description
`200`	200 response
`400`	400 response

List Pricing

List all available Pricing rates. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`country`	query	string	yes	Filter Fee Rates by country ISO 3166 alpha-2 code. (e.g. `US`)
`currency`	query	string	yes	Filter Fee Rates by currency ISO 4217 3-character code. (e.g. `USD`)
`plan`	query	string	no	Filter Fee Rates by Assortment package name. If it’s not provided, or the value is ‘any’, all the existing variants will be returned. (e.g. `[object Object]`)
`payment_type`	query	string	no	Filter Fee Rates by the payment type. If it’s not provided, or the value is ‘any’, all the existing variants will be returned. (e.g. `[object Object]`)
`channel`	query	string	no	Filter Fee Rates by the sales channel. If it’s not provided, or the value is ‘any’, all the existing variants will be returned. (e.g. `[object Object]`)
`item_type`	query	string	no	Filter Fee Rates by the item type. If it’s not provided, or the value is ‘any’, all the existing variants will be returned. (e.g. `[object Object]`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Questions

List Default Questions by Event

List default Questions by Event ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`include_all`	query	string	yes	Return the whole list of canned included or not (e.g. `true`)

Responses

Status	Description
`200`	200 response

Create a Default Question for an Event

Create a default Question for an Event. Returns the result as a `question` array.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Get Default Question by Id

Retrieve a Canned Question by Event and Question ID.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`question_id`	path	string	yes	Canned Question ID. (e.g. `email`)

Responses

Status	Description
`200`	200 response
`404`	404 response

Update Default Question by Id

Modify details of the canned question of the event

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`question_id`	path	string	yes	Canned Question ID. (e.g. `email`)

Responses

Status	Description
`200`	200 response
`400`	400 response
`404`	404 response

Delete Default Question by Id

Deactivate a canned question for the event

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`question_id`	path	string	yes	Canned Question ID. (e.g. `email`)

Responses

Status	Description
`200`	200 response
`404`	404 response

List Custom Questions by Event

List custom Questions by Event ID. Returns a paginated response, with a `question` array.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`as_owner`	query	string	no	Return private Events and fields.

Responses

Status	Description
`200`	200 response
`404`	404 response

Create a Custom question for an Event

Create a custom Question for an Event. Returns the result as a `question` array.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response
`403`	403 response

Get Custom Question by Id

Retrieve a Custom Question by Event and Question ID.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`question_id`	path	string	yes	Custom Question ID. (e.g. `642123456`)

Responses

Status	Description
`200`	200 response
`404`	404 response

Delete a Custom Question for an Event

Delete a custom Question by Event and Question ID.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`question_id`	path	string	yes	Custom Question ID. (e.g. `642123456`)

Responses

Status	Description
`200`	200 response
`403`	403 response
`404`	404 response

Reports

Retrieve a Sales Report

Retrieve a sales Report by Event ID or Event status.

Parameters

Name	In	Type	Required	Description
`event_ids`	query	string	yes	Event ID. (e.g. `12345`)
`event_status`	query	string	no	Event status. (e.g. `[object Object]`)
`start_date`	query	string	no	Event start date.
`end_date`	query	string	no	Event end date.
`filter_by (string, optional) - Further filter report by Ticket ID and currency. {“ticket_ids”`	query	string	yes	(e.g. `[1234, 5678], “currencies”: [“USD”],...}`)
`group_by`	query	string	no	Group response by specified parameter.
`period`	query	string	no	Time period in units of the selected `date_facet`. For example, if date_facet=hour, then period=3 returns 3 hours worth of data from the current time in the Event timezone.
`date_facet`	query	string	no	Date period. Day is the default choice. Monthly aggregation is represented by the first of the month. Weekly aggregation is represented by the ending Sunday of the week, where a week is defined as Monday-Sunday.
`timezone`	query	string	no	Timezone. If unspecified, by default the value is the timezone of the first Event. (e.g. `America/Los_Angeles`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Retrieve a Attendee Report

Retrieve an Attendee Report by Event ID or Event status.

Parameters

Name	In	Type	Required	Description
`event_ids`	query	string	yes	Event ID. (e.g. `12345`)
`event_status`	query	string	no	Event status. (e.g. `[object Object]`)
`start_date`	query	string	no	Start date.
`end_date`	query	string	no	End date.
`filter_by (string, optional) - Further filter report by Ticket ID and currency.{“ticket_ids”`	query	string	yes	(e.g. `[1234, 5678], “currencies”: [“USD”],...}`)
`group_by`	query	string	no	Group response by specified parameter.
`period`	query	string	no	Time period in units of the selected `date_facet`. For example, if date_facet=hour, then period=3 returns 3 hours worth of data from the current time in the Event timezone.
`date_facet`	query	string	no	Date period. Day is the default choice. Monthly aggregation is represented by the first of the month. Weekly aggregation is represented by the ending Sunday of the week, where a week is defined as Monday-Sunday.
`timezone`	query	string	no	Timezone. If unspecified, by default the value is the timezone of the first Event. (e.g. `America/Los_Angeles`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Seat Map

List Seat Maps by Organization

List Seat Maps of an Organization. >**Warning:** Response is not paginated yet, but will be paginated soon.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID. (e.g. `12345`)
`venue_id`	query	string	no	Filter Seat Maps by a venue. (e.g. `12345`)
`venue_name_filter`	query	string	no	Filter Seat Maps by sub-string match venue name.

Responses

Status	Description
`200`	200 response

Create Seat Map For Event

Create a Seat Map for a new reserved seating event by copying an existing seat map. Event must be a new reserved seating. Once a seat map is already created for the event, this endpoint will return error. [List Seat Maps by Organization](#ref-op-getOrganizationsOrganization_idSeatmaps-venue_id-venue_name_filter) can be used to find source seat maps and their IDs.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event Id (e.g. `1`)

Responses

Status	Description
`200`	200 response
`403`	403 response

Structured Content

Retrieve Latest Published Version of Structured Content by Event Id

Retrieve a paginated response of structured content for the given event `id`. This will retrieve the latest `published` version of the structured content. Therefore you must publish a version of the content before using this endpoint - aka send in `publish=true` with current set of modules to [Set Structured Content](#set-structured-content-by-event-id-and-version) endpoint. It will default to getting the structured content of the event listing page if no purpose is provided.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	Event Id (e.g. `1234`)
`purpose`	query	string	yes	(e.g. `listing`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Retrieve Latest Working Version of Structured Content by Event Id

Retrieve a paginated response of structured content for the given event `id`. This will retrieve the latest `working` version of the structured content - this means latest version that is either published or unpublished. It will default to getting the structured content of the event listing page if no purpose is provided.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	Event Id (e.g. `1234`)
`purpose`	query	string	yes	(e.g. `listing`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Set Structured Content by Event Id and Version

Add new structured content to the event `id` for a specific `version` of structured content. This endpoint encapsulates both create and update for structured content. It will default to creating/updating the structured content for the listing page if no purpose is provided. Make sure to send in `publish=true` with current\* set of modules. If you do not publish your structured content, then your most updated structured content will not be visible to public users looking at your event listing page - it will only be visible to you. From a technical perspective, [Get Latest Working Version of Structured Content by Event Id](#get-latest-working-version-of-structured-content-by-event-id) will return your most recent modules (published or unpublished), but [Get Latest Published Version of Structured Content by Event Id](#get-latest-publish-version-of-structured-content-by-event-id) will return only the latest structured content that has been published. \* If you ONLY send in `publish=true` without the current set of modules, it will not work - modules will return as empty. Make sure to send in your most current modules AND `publish=true`.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	Event Id (e.g. `21321`)
`version`	path	string	yes	Structured Content Version (e.g. `2`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Texts Overrides

Retrieve Text Overrides

Retrieve the Text Overrides for the selected locale for an organization, with options to filter by Venue or Event

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization Id (e.g. `123`)
`locale`	query	string	yes	The Locale for which you want the strings. (e.g. `en_US`)
`venue_id`	query	string	no	Venue ID. (e.g. `12345`)
`event_id`	query	string	no	Event ID. (e.g. `12345`)
`text_codes`	query	string	yes	List of text codes to retrieve

Responses

Status	Description
`200`	200 response
`400`	400 response

Create Text Overrides

Create the Text Overrides for an organization, Venue, or Event. Messages will be internationalized using the `locale` parameter if it's specified. In case we don't send the locale we have 2 scenarios: * If event_id is provided the event's locale will be used * For other cases default locale will be used.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization Id (e.g. `123`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Ticket Buyer Settings

Retrieve Ticket Buyer Settings by Event

Retrieve Ticket Buyer Settings by Event ID. Example: ```json { "confirmation_message": { "text": "<H1>Confirmation Message</H1>", "html": "Confirmation Message" }, "instructions": { "text": "<H1>Instructions</H1>", "html": "Instructions" }, "sales_ended_message": { "text": "<H1>Sales Ended Message</H1>", "html": "Sales Ended Message" }, "survey_info": { "text": "<b>Filling in this survey is required to attend the event</b>", "html": "Filling in this survey is required to attend the event" }, "event_id": "43253626762", "survey_name": "Registration Page Title", "refund_request_enabled": true, "allow_attendee_update": true, "survey_time_limit": 15, "redirect_url": null, "survey_respondent": "attendee", "survey_ticket_classes": ["125", "374"] } ```

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `1234`)

Responses

Status	Description
`200`	200 response
`400`	400 response
`403`	403 response
`404`	404 response

Update Ticket Buyer Settings for an Event

Update Ticket Buyer Settings by Event ID. Example: ```json { "ticket_buyer_settings": { "confirmation_message": { "text": "<H1>Confirmation Message</H1>", "html": "Confirmation Message" }, "instructions": { "text": "<H1>Instructions</H1>", "html": "Instructions" }, "sales_ended_message": { "text": "<H1>Sales Ended Message</H1>", "html": "Sales Ended Message" }, "survey_info": { "text": "<b>Filling in this survey is required to attend the event</b>", "html": "Filling in this survey is required to attend the event" }, "event_id": "43253626762", "survey_name": "Registration Page Title", "refund_request_enabled": true, "allow_attendee_update": true, "survey_time_limit": 15, "redirect_url": null, "survey_respondent": "attendee", "survey_ticket_classes": ["125", "374"] } } ```

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `1234`)

Responses

Status	Description
`200`	200 response
`400`	400 response
`403`	403 response
`404`	404 response

Ticket Class

Retrieve a Ticket Class

Retrieve a Ticket Class by Ticket Class ID.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`ticket_class_id`	path	string	yes	Ticket Class ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Update a Ticket Class

Update Ticket Class by Ticket Class ID.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`ticket_class_id`	path	string	yes	Ticket Class ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Create a Ticket Class

Create a new Ticket Class. > **Note:** After **May 7, 2020**, we will require you to provide an **inventory_tier_id** as part of your request for any **ticket_classes** you are creating or updating for a tiered event. For more information refer to our [changelog](https://www.eventbrite.it/platform/docs/changelog). > **Add-On creation:** First you will need to create an [Add-On Inventory Tier](https://www.eventbrite.it/platform/api#/reference/inventory-tiers/create-an-inventory-tier) with **count_against_event_capacity** set to false and then provide the **inventory_tier_id** of the Add-On Inventory Tier when creating a new Ticket Class as part of your request.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID (e.g. `12345`)
`ticket_class_id`	query	string	yes	Ticket Class ID (e.g. `1234`)

Responses

Status	Description
`200`	200 response
`400`	400 response

List Ticket Classes by Event

List Ticket Classes by Event ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`pos`	query	string	no	Only return ticket classes valid for the given point of sale
`category`	query	string	no	Filter Ticket Classes by Category (e.g. `[object Object]`)
`include_holds`	query	string	no	Boolean for whether or not to include hold ticket classes in response

Responses

Status	Description
`200`	200 response

List Ticket Classes Available For Sale by Event

List Ticket Classes available for sale by Event ID for use in the purchase flow. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`event_id`	path	string	yes	Event ID. (e.g. `12345`)
`pos`	query	string	no	Only return ticket classes valid for the given point of sale. If unspecified, `online` is the default value.
`code`	query	string	no	Only return ticket classes associated with this promo code. A promo code may apply discount, unlock hidden tickets, or change availability/remaining quantity of the tickets.
`hold_id`	query	string	no	Only return ticket classes associated with this composite hold id. Requesting user must have event permissions to sell from holds.

Responses

Status	Description
`200`	200 response
`400`	400 response
`403`	403 response
`404`	404 response

Ticket Group

Retrieve a Ticket Group

Retrieve a Ticket Group by Ticket Group ID.

Parameters

Name	In	Type	Required	Description
`ticket_group_id`	path	string	yes	Ticket Group ID. (e.g. `1`)

Responses

Status	Description
`200`	200 response

Update a Ticket Group

Update Ticket Group by Ticket Group ID.

Parameters

Name	In	Type	Required	Description
`ticket_group_id`	path	string	yes	Ticket Group ID. (e.g. `1`)

Responses

Status	Description
`200`	200 response

Delete a Ticket Group

Delete a Ticket Group. The status of the Ticket Group is changed to `deleted`.

Parameters

Name	In	Type	Required	Description
`ticket_group_id`	path	string	yes	Ticket Group ID. (e.g. `1`)

Responses

Status	Description
`200`	200 response

Create a Ticket Group

Create a new Ticket Group for an [Organization](#organization_object). Maximum number of 300 live Ticket Groups per Organization; archived or deleted Ticket Classes are not included in this limitation.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID. (e.g. `1`)

Responses

Status	Description
`200`	200 response
`400`	400 response

List Ticket Groups by Organization

List Ticket Groups by Organization ID. Returns a paginated response. To include the Ticket Class name and sales channel in the response, add the Ticket Class expansion parameter.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID. (e.g. `1`)
`status`	query	string	no	Filter Ticket Groups by status. This can be `live`, `archived`, `deleted`, or `all`.

Responses

Status	Description
`200`	200 response

Add a Ticket Class to Ticket Groups

Add a Ticket Class to Ticket Groups by Organization ID and Event ID. To remove a Ticket Class from every Ticket Group owned by an Organization, leave the Ticket Group ID empty.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	ID of the Organization that owns the Ticket Group. (e.g. `1`)
`event_id`	path	string	yes	ID of the Event that owns the Ticket Class. (e.g. `123`)
`ticket_class_id`	path	string	yes	ID of the Ticket Class to add to the Ticket Group. (e.g. `12345`)

Responses

Status	Description
`204`	204 response

User

Retrieve Information about a User Account

Returns a user for the specified `user` as user. If you want to get details about the currently authenticated user, use /users/me/. To include the User’s assortment package in the response, add the assortment expansion parameter: /users/me/?expand=assortment

Parameters

Name	In	Type	Required	Description
`user_id`	path	string	yes	User ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Retrieve Information About Your User Account

Retrieve your User account information.

Responses

Status	Description
`200`	200 response

Venue

Retrieve a Venue

Retrieve a Venue by Venue ID.

Parameters

Name	In	Type	Required	Description
`venue_id`	path	string	yes	Venue ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Update a Venue

Update a Venue by Venue ID.

Parameters

Name	In	Type	Required	Description
`venue_id`	path	string	yes	Venue ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Create a Venue

Create new Venue under an Organization.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

List Venues by Organization

List Venues by Organization ID. Returns a paginated response.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID. (e.g. `12345`)

Responses

Status	Description
`200`	200 response

Webhooks

Create Webhooks by Organization ID

Create a Webhook by Organization ID.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	Organization ID (e.g. `389957889113`)

Responses

Status	Description
`200`	200 response

List Webhook by Organization ID

List Webhooks by Organization ID.

Parameters

Name	In	Type	Required	Description
`organization_id`	path	string	yes	(e.g. `389957889113`)

Responses

Status	Description
`200`	200 response
`400`	400 response

Create Webhooks - deprecated

Create a Webhook. > Warning: Access to this API will be no longer usable on June 1st, 2020. For more information regarding deprecated APIs, refer to our [changelog](https://www.eventbrite.it/platform/docs/changelog).

Parameters

Name	In	Type	Required	Description
`organization_id`	query	string	yes	Organization ID (e.g. `389957889113`)

Responses

Status	Description
`200`	200 response
`403`	403 response

List of Webhooks - deprecation

List Webhooks. > Warning: Access to this API will be no longer usable on June 1st, 2020. For more information regarding deprecated APIs, refer to our [changelog](https://www.eventbrite.it/platform/docs/changelog).

Responses

Status	Description
`200`	200 response
`400`	400 response

Delete Webhook by ID

Delete a Webhook by ID.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	Webhook ID. (e.g. `1990496`)

Responses

Status	Description
`200`	200 response
`400`	400 response
`403`	403 response

Eventbrite API v3

Attendee

Retrieve an Attendee

Parameters

Responses

List Attendees by Event

Parameters

Responses

List Attendees by Organization

Parameters

Responses

Balance

Remaining Balance

Parameters

Responses

Categories

Category by ID

Parameters

Responses

Subcategory by ID

Parameters

Responses

List of Categories

Responses

List of Subcategories

Responses

Discount

Retrieve a Discount

Parameters

Responses

Update a Discount

Parameters

Responses

Delete a Discount

Parameters

Responses

Create a Discount

Parameters

Responses

Search Discounts by Organization

Parameters

Responses

Display Settings

Retrieve Display Settings

Parameters

Responses

Update Display Settings

Parameters

Responses

Event Capacity

Retrieve a Capacity Tier

Parameters

Responses

Update a Capacity Tier

Parameters

Responses

Event Description

Retrieve Full HTML Description

Parameters

Responses

Event Schedule

Create an event schedule

Parameters

Responses

Event Search

Search Events - deprecated

Parameters

Responses

Event Series

Retrieve an Event Series

Parameters

Responses

Event Teams

List by Event

Parameters

Responses

Retrieve Team

Parameters

Responses

List Attendees by Team