Skip Main Navigation
Page Content

Users

Note

These URLs will accept “me” in place of a user ID in URLs - for example, /users/me/orders/ will return orders placed by the current user.

GET /users/:id/

Returns a user for the specified user as user. If you want to get details about the currently authenticated user, use /users/me/.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /users/:id/orders/

Returns a paginated response of orders, under the key orders, of all orders the user has placed (i.e. where the user was the person buying the tickets).

param int id:The id assigned to a user.
param datetime changed_since:
 (optional) Only return attendees changed on or after the time given.

Note

A datetime represented as a string in ISO8601 combined date and time format, always in UTC.

Parameters

Name Type Required Description
changed_since datetime No Only return resource changed on or after the time given
time_filter string No Limits results to either past or current & future events / orders. (Valid choices are: all, past, or current_future)

Errors

No endpoint-specific errors

GET /users/:id/organizers/

Returns a paginated response of organizer objects that are owned by the user.

Parameters

Name Type Required Description
hide_unsaved boolean No True: Will hide organizers flagged as “unsaved” False: Will show organizers regardless of unsaved flag (Default value)

Errors

No endpoint-specific errors

GET /users/:id/owned_events/

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/

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

No endpoint-specific errors

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.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.
  • 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/venues/

Returns a paginated response of venue objects that are owned by the user.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

POST /organizations/:id/venues/

Creates new venue objects under an organization and returns it as venue.

Parameters

Name Type Required Description
venue.name string Yes The name of the venue
venue.google_place_id string No The google place id for the venue
venue.organizer_id string No The organizer this venue belongs to (optional - leave this off to use the default organizer)
venue.address.address_1 string No The first line of the address
venue.address.address_2 string No The second line of the address
venue.address.city string No The city where the venue is
venue.address.region string No The region where the venue is
venue.address.postal_code string No The postal_code where the venue is
venue.address.country string No The country where the venue is
venue.address.latitude decimal No The latitude of the coordinates for the venue
venue.address.longitude decimal No The longitude of the coordinates for the venue
venue.age_restriction string No The age restrictions for the venue
venue.capacity integer No The max capacity for the venue

Errors

No endpoint-specific errors

GET /users/:id/owned_event_attendees/

Returns a paginated response of attendees, under the key attendees, of attendees visiting any of the events the user owns (events that would be returned from /users/:id/owned_events/)

Parameters

Name Type Required Description
status string No Limits results to either confirmed attendees or cancelled/refunded/etc. attendees (Valid choices are: attending, or not_attending)
changed_since datetime No Only return resource changed on or after the time given

Errors

No endpoint-specific errors

GET /users/:id/owned_event_orders/

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

Parameters

Name Type Required Description
status string No Filter to active (attending), inactive (not attending), or all (both) orders (Valid choices are: active, inactive, or all)
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
changed_since datetime No Only return resource changed on or after the time given

Errors

No endpoint-specific errors

GET /users/:id/contact_lists/

Returns a list of contact_list that the user owns as the key contact_lists.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

POST /users/:id/contact_lists/

Makes a new contact_list for the user and returns it as contact_list.

Parameters

Name Type Required Description
contact_list.name string Yes Name of the new contact list

Errors

No endpoint-specific errors

GET /users/:id/contact_lists/:contact_list_id/

Gets a user’s contact_list by ID as contact_list.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

POST /users/:id/contact_lists/:contact_list_id/

Updates the contact_list and returns it as contact_list.

Parameters

Name Type Required Description
contact_list.name string Yes New name of the contact list

Errors

No endpoint-specific errors

DELETE /users/:id/contact_lists/:contact_list_id/

Deletes the contact list. Returns {"deleted": true}.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /users/:id/contact_lists/:contact_list_id/contacts/

Returns the contacts on the contact list as contacts.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

POST /users/:id/contact_lists/:contact_list_id/contacts/

Adds a new contact to the contact list. Returns {"created": true}.

There is no way to update entries in the list; just delete the old one and add the updated version.

Parameters

Name Type Required Description
contact.email string Yes Contact’s email address
contact.first_name string No Contact’s first name (or full name)
contact.last_name string No Contact’s last name

Errors

No endpoint-specific errors

DELETE /users/:id/contact_lists/:contact_list_id/contacts/

Deletes the specified contact from the contact list. Returns {"deleted": true}.

Parameters

Name Type Required Description
email string Yes Email address to remove

Errors

No endpoint-specific errors

GET /users/:id/bookmarks/

Gets all the user’s saved events.

In order to update the saved events list, the user must unsave or save each event.

A user is authorized to only see his/her saved events.

Parameters

Name Type Required Description
bookmark_list_id string No Optional bookmark list id to fetch all bookmarks from

Errors

No endpoint-specific errors

POST /users/:id/bookmarks/save/

Adds a new bookmark for the user. Returns {"created": true}.

A user is only authorized to save his/her own events.

Parameters

Name Type Required Description
event_id integer No Event id to bookmark for the user
event_ids list No Event ids to batch bookmark for the user
bookmark_list_id string No Optional Bookmark list id to save the bookmark(s) to

Errors

  • BOOKMARK_ALREADY_EXISTS: The bookmark you are attempting to create already exists.

POST /users/:id/bookmarks/unsave/

Removes the specified bookmark from the event for the user. Returns {"deleted": true}.

A user is only authorized to unsave his/her own events.

Parameters

Name Type Required Description
event_id integer No Event id to bookmark for the user
event_ids list No Event ids to batch bookmark for the user
bookmark_list_id string No Bookmark list id to save the bookmark(s) to

Errors

No endpoint-specific errors

GET /users/:user_id/ticket_groups/

Returns a paginated response of ticket_group for the specified user. The alias me (/users/me/) may be used to refer to the currently authenticated user.

To include the ticket class name and sales channel in the response, add the tickets expansion parameter: /users/me/?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 /users/:user_id/events/:event_id/ticket_classes/:ticket_class_id/ticket_groups/

Add the Ticket Class with the specified :ticket_class_id of the event with :event_id that belongs to the user with :user_id to many Ticket Groups specified with ticket_group_ids. If the list provided is empty, remove this ticket class from every ticket group.

Parameters

Name Type Required Description
ticket_group_ids list No IDs of all ticket group this ticket belongs to. If this is not passed will remove all ticket groups from the ticket.

Errors

No endpoint-specific errors

Example request

POST Associate the ticket class to several ticket groups
https://www.eventbriteapi.com/v3/users/me/events/:event_id/ticket_classes/:ticket_class_id/ticket_groups/

JSON Data example:

{
    "ticket_group_ids": ["11", "20"]
}
POST Remove all the associations that this ticket class have in every ticket group
https://www.eventbriteapi.com/v3/users/me/events/:event_id/ticket_classes/:ticket_class_id/ticket_groups/

JSON Data example:

{
    "ticket_group_ids": []
}

GET /users/:user_id/discounts/

Returns a paginated response of cross_event_discount for the specified user. This operation is only supported for the currently authenticated user. The alias me (/users/me/) may be used.

Scopes:

  • event - searches single event discounts associated to given event_id (event_id required).
  • multi_events - searches for multi event discounts (ticket_group_id optional).
  • user - searches for all discounts associated to the given event_id (event_id required).

Parameters

Name Type Required Description
page_size integer No Number of records in each page.
order_by string No How to order the results (Valid choices are: code_asc, code_desc, discount_type_asc, discount_type_desc, start_asc, or start_desc)
type list No Filter discounts with a specific discount type set. This should be a comma delimited string of discount types. Valid discount type: coded, access, public, hold
ticket_group_id string No ID of the ticket group.
scope string No Type of discount scopes. (Valid choices are: event, multi_events, or user)
code_filter string No Search term to filter discounts by name.
code string No Search term to find discounts by code/name, in an exact match behavior.
event_id string No ID of the event. Will only search discounts of this event.

Errors

  • CODE_AND_CODE_FILTER_PROVIDED: Only one of code or code_filter may be provided at the same time.
  • INVALID
  • INVALID_USAGE_FOR_EVENT_ID: Event ID can not be used along with multi_events discount_scope.
  • ORDER_BY_NOT_SUPPORTED: code is the only field by which results may be ordered. Exactly one of code or code_filter filters must be provided for sorting to be allowed.

Example request

GET
https://www.eventbriteapi.com/v3/users/me/discounts/?scope=user&event_id=:event_id
  • Returns all single and cross event discounts associated with the event_id provided.
GET
https://www.eventbriteapi.com/v3/users/me/discounts/?scope=event&event_id=:event_id
  • Returns all single event discounts associated with the event_id provided.
GET
https://www.eventbriteapi.com/v3/users/me/discounts/?scope=multi_events&ticket_group_id=:ticket_group_id
  • Returns all cross event discounts associated with the ticket_group_id provided.
GET
https://www.eventbriteapi.com/v3/users/me/discounts/?scope=event&event_id=:event_id&code=SUMMER2017
  • Returns all single event discounts associated with the event_id provided, that exactly match the code provided.
  • The code parameter must be at least two characters long.
GET
https://www.eventbriteapi.com/v3/users/me/discounts/?scope=event&event_id=:event_id&code_filter=SUMM
  • Returns all single event discounts associated with the event_id provided and with codes that start with the code_filter parameter provided.
  • The code_filter parameter must be at least two characters long.

GET /users/:id/assortment/

Retrieve the assortment for the user.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

POST /users/:id/assortment/

Set a user’s assortment and returns the assortment for the specified user.

Parameters

Name Type Required Description
plan string Yes The assortments package to upgrade/downgrade to. (Valid choices are: package1, or package2)

Errors

No endpoint-specific errors