Getting Information on Events

You can get detailed information about an Event using the expansion feature and specific endpoints of the API. This information is helpful when working with an Event. The first step in getting information on an Event is to identify the Event ID.

Authenticating Your Access to the Eventbrite API

You must first authenticate your access to the Eventbrite API before getting information on an Event. To learn how, refer to Authenticating Your Access.

Finding an Event ID

There are two ways to find an Event ID:

From the Eventbrite website.
Using an API GET request.

Using the Eventbrite Website to Find an Event ID

An Event URL includes the Event ID. To view the Event URL of an Event you have created:

Make sure you are logged into your Eventbrite account.
Click the Profile icon on the top-right and choose Manage Events from the drop down menu.
Click on the Event of interest.
In the URL field at the top, you see something like https://www.eventbrite.com/myevent?eid=123456789. The number after eid= is the Event ID. In this example, the Event ID is 123456789.

Using the Eventbrite API to Find an Event ID

There are several ways to find Event IDs with the API. The simplest API call is below, which returns a list of Events that belong to the organization.

curl -X GET   https://www.eventbriteapi.com/v3/organizations/{organization_id}/events/   -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

You will get a list of Events and a pagination object in return. For each Event object, the id attribute is the event_id.

Obtaining your Organization ID

curl -X GET   https://www.eventbriteapi.com/v3/users/me/organizations/   -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

You will get a list of Organizations and a pagination object in return. For each Organization object, the id attribute is the organization_id.

Using Expansions to Get Information on an Event

To limit the number of calls to the API, and the size of the responses, by default data returned on an Event is short and shows only basic information (subset) about the object. However, you can obtain additional and expanded information on certain Event object elements by using expansions.

The endpoint expansion is appended as a parameter to the GET call. For example, if you want to expand the Ticket Classes information on the Event, you will call the below

curl -X GET   https://www.eventbriteapi.com/v3/events/{event_id}/?expand=ticket_classes   -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

The Ticket Classes object (an array of Ticket Class) attached in the Event object is returned.

{
  ...
  "ticket_classes": [
        {
            "resource_uri": "https://www.eventbriteapi.com/v3/events/12345/ticket_classes/12345/",
            "variant_id": null,
            "name": "test",
            "description": null,
            "donation": false,
            "free": true,
            "minimum_quantity": 1,
            "maximum_quantity": null,
            "maximum_quantity_per_order": 10,
            "maximum_quantity_per_order_without_pending": null,
            "on_sale_status": "AVAILABLE",
            "quantity_total": 100,
            "quantity_sold": 23,
            "sales_start": "2018-11-21T21:25:00Z",
            "sales_end": "2019-06-01T04:00:00Z",
            "hidden": false,
            "include_fee": false,
            "split_fee": false,
            "hide_description": true,
            "auto_hide": false,
            "variants": [],
            "has_pdf_ticket": true,
            "sales_channels": [
                "online",
                "atd"
            ],
            "delivery_methods": [
                "electronic"
            ],
            "event_id": "12345",
            "id": "12345"
        },
        ...
    ],
  ...
}

The most commonly used Event endpoint expansions are:

Expansion	Source	Description
`venue`	`venue_id`	Event Venue Detailed Venue information including address. See example below.
`organizer`	`organizer_id`	Event Organizer Information on the Event sponsor.
`format`	`format_id`	Event Format. Event type, for example conference, seminar, concert.
`category`	`category_id`	Event Category. Event class, such as Music. See example below.
`subcategory`	`subcategory_id`	Event Subcategory. Event subclass, for example Classical.
`bookmark_info`	`bookmark_info`	Visitor to the Eventbrite website has saved the Event as a bookmark. Returns false if there are no bookmarks. If there are bookmarks, returns a a dictionary specifying the number of visitors who have bookmarked the Event as a count object like `{count:3}`.
`refund_policy`	`refund_policy`	Event refund policy.
`ticket_classes`	`ticket_classes`	Information on the Event Ticket Classes. See the page Working With Ticket Classes and Ticket Groups for information and an example of using this specific expansion.
`ticket_availability`	`ticket_availability`	Number of Event Ticket Classes unsold and available for registration (free) or purchase. See example below.
`external_ticketing`	`external_ticketing`	External ticketing data for the Event.
`music_properties`	`music_properties`	Properties for a music Event.
`publish_settings`	`publish_settings`	Event publish settings.
`guestlist_metrics`	`guestlist_metrics`	Metrics of Event guestlists.

Getting Information on Event Venue

To get specific information on an Event Venue (location), use the expansion by adding the expand=venue parameter in the request URL.

curl -X GET   https://www.eventbriteapi.com/v3/events/{event_id}/?expand=venue   -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

The Venue object attached in the Event object is returned.

{
  ...
  "venue": {
    "name": "Madison Square Garden",
    "age_restriction": "AGE_RESTRICTION_ALL_AGES",
    "capacity": 100,
    "id": "3003",
    "address": {
      "address_1": "",
      "address_2": "",
      "city": "",
      "region": "",
      "postal_code": "",
      "country": "",
      "latitude": 0,
      "longitude": 0,
      "localized_address_display": "",
      "localized_area_display": "",
      "localized_multi_line_address_display": []
    },
    "resource_uri": "https://www.eventbriteapi.com/v3/venues/3003/"
  },
  ...
}

Getting Information on Event Category

To find out the category of an Event (for example, music), use the expansion by adding expand=category parameter in the request URL.

curl -X GET   https://www.eventbriteapi.com/v3/events/{event_id}/?expand=category   -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

The Category object attached in the Event object is returned.

{
  ...
  "category": {
    "id": "103",
    "resource_uri": "https://www.eventbriteapi.com/v3/categories/103/",
    "name": "Music",
    "name_localized": "Music",
    "short_name": "Music",
    "short_name_localized": "Music",
  },
  ...
}

Getting Information on Event Ticket Availability

Use the expansion to identify the number of tickets remaining (unsold) for an Event, by adding the expand=ticket_availability parameter in the request URL.

curl -X GET   https://www.eventbriteapi.com/v3/events/{event_id}/?expand=ticket_availability   -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

The Ticket Availability object attached in the Event object is returned.

{
  ...
  "ticket_availability": {
        "has_available_tickets": true,
        "minimum_ticket_price": {
            "currency": "USD",
            "value": 100,
            "major_value": "1.00",
            "display": "1.00 USD"
        },
        "maximum_ticket_price": {
            "currency": "USD",
            "value": 100,
            "major_value": "1.00",
            "display": "1.00 USD"
        },
        "is_sold_out": false,
        "start_sales_date": {
            "timezone": "America/Vancouver",
            "local": "2018-11-26T00:00:00",
            "utc": "2018-11-26T08:00:00Z"
        }
    },
  ...
}

Using Orther Endpoints to Get Information on a list of Events

Several endpoints return information on a list of Events.

List your Events by Status

Use the status parameter to get a list of the organization's Events with the status of interest. The status fields are:

draft - Preliminary form of a possible future Event.
live - Tickets can be obtained for the Event.
started - Start date of the Event.
ended - End date of the Event.
canceled - Canceled Events.

curl -X GET   https://www.eventbriteapi.com/v3/organizations/{organization_id}/events/?status=live   -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

List your Events by Date

Use the time_filter parameter to get a list of the organization's Events with the start date of interest. The time_filter fields are:

past - Return past Events.
current_future - Return current and future Events.
all - Return all Events.

curl -X GET   https://www.eventbriteapi.com/v3/organizations/{organization_id}/events/?time_filter=current_future   -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

List your Events By Venue

You can return a list of all Events at a specific Venue by using this call

curl -X GET   https://www.eventbriteapi.com/v3/venues/{venue_id}/events/   -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

Next steps

These are the next articles to continue with your building

Working With Ticket Classes and Ticket Groups

Continue

Creating Ticket Classes in Tiered Events

Continue