Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed "quantity" from sorting options because it errors.
Page Properties
labelapi_docs_CONTROLLERNAME
NameTicket Groups Index
DescriptionLists all ticket groups for an event
TypeGET
URL/v9/ticket_groups
Credential TypeAPI|User
Supports PaginationNo

...

Name
Description
Value Type
Required
event_idID of the Event for which you would like to list ticketsintegerRequired
show_pastInclude tickets for events in the pastbooleanOptional
office_idShow only tickets owned by a specific officeintegerOptional
type

Filter by type:

  • event
  • parking
stringOptional
quantityFilter by number of tickets greater than passed valueintegerOptional
sectionFilter by exact match sectionStringOptional
rowFilter by exact match rowStringOptional
last_minute_ticketsFilter by tickets owned by offices that have opted in to list their tickets last-minuteintegerOptional
exclude_office_idExclude tickets owned by a specific officeintegerOptional
wheelchairFilter by wheelchair-accesssible ticketsbooleanOptional
include_unavailableList all tickets (overrides default behavior of listing only available)booleanOptional
order_by

Sort results by any of the following parameters:

  • retail_price
  • section
  • row
  • format
  • available_count
  • wheelchair
  • in_handquantity

Adjust the sort direction by appending ASC or DESC. e.g.: order_by=available_count+DESC

String

Optional
format

Filter results to one or more specific ticket format(s):

  • Physical
  • Eticket
  • Flash_seats
  • Guest_list (no actual ticket)
  • Paperless

To include multiple formats separate them by a comma. e.g.: format=Physical,Eticket

StringOptional.
eticketDisplay only eTickets. Deprecated. Use format insteadBooleanOptional
instant_deliveryDisplay only tickets available for “Instant Delivery”. Only etickets are available for Instant Delivery.booleanOptional
updated_atFilter by ticket updated atDateOptional
stateFilter by ticket statestringOptional
lightweightReturn a significantly smaller response with less details for greater speed
(Hint: You should almost always set this to true
boolean

Optional,

Default: false

ticket_list

Omits the seat-level detail from the response.

(Hint: You should almost always set this to false)

boolean

Optional

Default: false

...