Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

NameTicket Groups Index
DescriptionLists all ticket groups for an event
TypeGET
URL/v9/ticket_groups
Credential TypeAPI|User
Supports PaginationNo

Long Description

Returns all ticket groups for the given event_id. This endpoint does not support pagination—all ticket groups matching your query will be returned.

Most users will want to use both lightweight=true and ticket_list=false to achieve the fastest results.

If you are testing in the Sandbox the events named "Test Event" is recommended as it they several large ticket groups of various types and statuses.

 

Each Ticket Group in the response will include an available_ticket_count property, which indicates how many tickets are currently available to sell.

Parameters

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_hand

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
  • TM_mobile
  • 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

 

Examples

RequestResponse
/v9/ticket_groups?eticket=true&event_id=629257&lightweight=true
 

 

 

{
  "total_entries":1,
  "ticket_groups":[
    {
      "retail_price":27.0,
      "type":"event",
      "signature":"a8d6952ce14f9e9d8594649601499b9c",
      "section":"600",
      "view_type":"Full",
      "in_hand":true,
      "office":{
        "brokerage":{
          "abbreviation":"Core",
          "name":"Core Tickets",
          "url":"/brokerages/1756",
          "id":1756
        },
        "name":"Core",
        "url":"/offices/1752",
        "id":1752
      },
      "wheelchair":false,
      "format":"Physical",
      "splits":[
        2
      ],
      "eticket":true,
	  "instant_delivery":true,
      "in_hand_on":null,
      "wholesale_price":7.0,
      "broadcast":"t",
      "public_notes":null,
      "featured":false,
      "row":"A",
      "quantity":26,
      "url":"/ticket_groups/52554287",
      "id":52554287,
      "ticket_states":{
        "available":2,
        "sold":24
      }
    }
  ]
}
  • No labels