Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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_id

ID 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
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

include_tevo_section_mappingsWhen set to true results will include an additional parameter, {{tevo_section_name}}, which indicates the canonical section name to be used with ticketevolution/seatmaps-client. This should only be set to true if you are utilizing Ticket Evolution seat maps.BooleanOptional
Default: false

...

RequestResponse

Example of a request using {{lightweight=true}} which is recommended for all requests to this endpoint
/v9/ticket_groups?event_id=1443642&include_tevo_section_mappings=true&lightweight=true&order_by=retail_price&type=event


Code Block
languagejs
themeRDark
titleResults from /ticket_groups
linenumberstrue
{
  "total_entries": 66,
  "ticket_groups": [
    {
      "id": 506945848,
      "url": "/ticket_groups/506945848",
      "type": "event",
      "row": "9",
      "section": "211",
      "quantity": 1,
      "available_quantity": 1,
      "wholesale_price": 251.32,
      "eticket": true,
      "instant_delivery": true,
      "intended_for_instant_delivery": false,
      "in_hand": true,
      "in_hand_on": null,
      "public_notes": null,
      "splits": [
        1
      ],
      "featured": false,
      "retail_price": 251.32,
      "format": "Eticket",
      "view_type": null,
      "broadcast": "t",
      "wheelchair": false,
      "signature": "Z1hGWlMrZ3A0UkhhNFhBaFdUSXpCOGFuMXZielhmT2hhVkxUMmhXQ1ZQND0tLVp5cW9WRzJqVm1pYVNxbm1iZ2tGUHc9PQ==--3c48da54088690d3d3bdbee4d039857219065bb1",
      "ticket_states": {
        "available": 1
      },
      "office": {
        "id": 1692,
        "url": "/offices/1692",
        "name": "Auto-Purchase",
        "brokerage": {
          "id": 1700,
          "url": "/brokerages/1700",
          "name": "Auto-Purchase",
          "abbreviation": "TEvo"
        }
      },
      "natb_member": false,
      "tevo_section_name": "Middle Level Sideline 211"
    }

    …

  ]
}


Example of a request that does not request the lightweight results. This is NOT recommended.

/v9/ticket_groups?event_id=1443642&include_tevo_section_mappings=true&order_by=retail_price&type=event


Code Block
languagejs
themeRDark
titleResults from /ticket_groups
linenumberstrue
{
  "total_entries": 66,
  "ticket_groups": [
    {
      "tevo_section_name": "Middle Level Sideline 211"
      "id": 506945848,
      "url": "/ticket_groups/506945848",
      "type": "event",
      "row": "9",
      "section": "211",
      "quantity": 1,
      "available_quantity": 1,
      "wholesale_price": 251.32,
      "eticket": true,
      "instant_delivery": true,
      "intended_for_instant_delivery": false,
      "in_hand": true,
      "in_hand_on": null,
      "remote_id": null,
      "public_notes": null,
      "private_notes": null,
      "exchange_notes": null,
      "created_at": "2018-09-06T19:00:32Z",
      "updated_at": "2018-11-02T00:30:20Z",
      "splits": [
        1
      ],
      "ticket_states": {
        "available": 1
      },
      "ticket_hold_ids": [
        "NULL"
      ],
      "seats": [],
      "tickets": [
        [
          "available",
          "NULL"
        ]
      ],
      "has_spec_tickets": false,
      "featured": false,
      "retail_price": 251.32,
      "format": "Eticket",
      "face_value": null,
      "view_type": null,
      "broadcast": "t",
      "wheelchair": false,
      "evopay_discount": 0,
      "evopay_discount_price": 218.54,
      "ticket_costs": [
        null
      ],
      "ticket_purchase_order_ids": [
        null
      ],
      "freshness": "> 240 mins",
      "signature": "Z1lBNnJ2ODJCbWpVQjN4cS9Zd3pIUk5vc2Z6WHBHZWNHRVRYM1F4MW55bz0tLXhlMlhrTjBMWVRVcWJLUlZzUUR0VUE9PQ==--4cc7f77a65a5410cc88a26f2037d8b4196772256",
      "event": {
        "id": 1443642,
        "url": "/events/1443642",
        "name": "Fleetwood Mac",
        "occurs_at": "2019-03-11T20:00:00Z"
      },
      "office": {
        "id": 1692,
        "url": "/offices/1692",
        "name": "Auto-Purchase",
        "brokerage": {
          "id": 1700,
          "url": "/brokerages/1700",
          "name": "Auto-Purchase",
          "abbreviation": "TEvo Seller"
        }
      },
      "natb_member": false
    },

    …

  ]
}





...