7b222e8ec91c
List all events
Returns a list of events belonging to the box office.
Query parameters
Unix timestamp filter that returns items with matched start_at value.
Unix timestamp filter that returns items with start_at greater than given value.
Unix timestamp filter that returns items with start_at greater than or equal given value.
Unix timestamp filter that returns items with start_at less than given value.
Unix timestamp filter that returns items with start_at less than or equal given value.
Unix timestamp filter that returns items with matched end_at value.
Unix timestamp filter that returns items with end_at greater than given value.
Unix timestamp filter that returns items with end_at greater than or equal given value.
Unix timestamp filter that returns items with end_at less than given value.
Unix timestamp filter that returns items with end_at less than or equal given value.
A paginator cursor value of object id (e.g. "or_123") that defines place in the list. To fetch next page of results, use the last object id from the current result list, e.g. starting_after=or_223.
A paginator cursor value of object id (e.g. "or_123") that defines place in the list. To fetch previous page of results, use the first object id from the current result list, e.g. ending_before=or_123.
The number of items to retrieve
A comma separated list of event series status. (e.g. draft,published)
A string representing the event name
A string representing the event venue
Response
A successfully returned list of events
Example response
{
"data": [
{
"object": "event",
"id": "ev_1",
"available_status": "This event is available",
"chk": "da99",
"access_code": null,
"call_to_action": "Buy tickets / Join the guestlist",
"checkout_url": "https://www.tickettailor.com/checkout/view-event/id/1/chk/da99/",
"created_at": 1583771084,
"currency": "gbp",
"description": null,
"end": {
"date": "2020-05-01",
"formatted": "Fri 1 May 2020 10:30 PM",
"iso": "2020-05-01T22:30:00+01:00",
"time": "22:30",
"timezone": "+01:00",
"unix": 1588368600
},
"hidden": "false",
"images": {
"header": "https://d37ecpm5it19bz.cloudfront.net/c_crop,dpr_1.0,h_1921,q_100,w_1922,x_479,y_0/c_scale,g_center,h_326,q_85,w_1024/v1/stitching/userfiles/acfi9eknr1vur6wguu5s.jpg",
"thumbnail": "https://d37ecpm5it19bz.cloudfront.net/c_crop,dpr_1.0,h_1921,q_100,w_1922,x_479,y_0/c_scale,h_108,q_85,w_108/v1/stitching/userfiles/acfi9eknr1vur6wguu5s.jpg"
},
"max_tickets_sold_per_occurrence": null,
"name": "Hackney Downs 2020 Tulip Festival",
"online_event": "false",
"online_link": null,
"override_id": null,
"payment_methods": [
{
"external_id": null,
"id": "pm_6687",
"instructions": "Pay when you arrive to festival",
"name": "Pay on the door",
"type": "offline"
},
{
"external_id": "seller222@example.com",
"id": "pm_6691",
"instructions": null,
"name": null,
"type": "paypal"
}
],
"private": "false",
"revenue": 0,
"show_map": "true",
"sales_tax_label": "VAT",
"sales_tax_percentage": 20,
"sales_tax_treatment": "exclusive",
"start": {
"date": "2020-05-01",
"formatted": "Fri 1 May 2020 6:00 PM",
"iso": "2020-05-01T18:00:00+01:00",
"time": "18:00",
"timezone": "+01:00",
"unix": 1588352400
},
"status": "published",
"ticket_groups": [
{
"object": "ticket_group",
"id": "tg_21099",
"bundle_ids": [],
"max_per_order": 10,
"max_quantity": 100,
"min_per_order": 1,
"name": "April 20th",
"sort_order": 50050,
"ticket_ids": [
"tt_230625",
"tt_230626"
]
},
{
"object": "ticket_group",
"id": "tg_21100",
"bundle_ids": [],
"max_per_order": 10,
"max_quantity": 100,
"min_per_order": 1,
"name": "April 21st",
"sort_order": 50100,
"ticket_ids": [
"tt_230631",
"tt_230632"
]
}
],
"ticket_types": [
{
"object": "ticket_type",
"id": "tt_230625",
"access_code": null,
"booking_fee": 0,
"description": null,
"group_id": "tg_21099",
"max_per_order": 100,
"min_per_order": 1,
"name": "4.20 Adult (13-61) - Presale",
"price": 800,
"status": "hidden",
"sort_order": 50050,
"type": "paid",
"quantity": 10000,
"quantity_held": 0,
"quantity_issued": 5000,
"quantity_total": 15000
},
{
"object": "ticket_type",
"id": "tt_230626",
"access_code": null,
"booking_fee": 0,
"description": null,
"group_id": "tg_21099",
"max_per_order": 100,
"min_per_order": 1,
"name": "4.20 Senior (62+) - Presale",
"price": 600,
"status": "on_sale",
"sort_order": 50051,
"type": "paid",
"quantity": 10000,
"quantity_held": 0,
"quantity_issued": 2000,
"quantity_total": 12000
},
{
"object": "ticket_type",
"id": "tt_230631",
"access_code": null,
"booking_fee": 0,
"description": null,
"group_id": "tg_21100",
"max_per_order": 100,
"min_per_order": 1,
"name": "4.21 Adult (13-61) - Presale",
"price": 800,
"status": "on_sale",
"sort_order": 50100,
"type": "paid",
"quantity": 10000,
"quantity_held": 0,
"quantity_issued": 4000,
"quantity_total": 14000
},
{
"object": "ticket_type",
"id": "tt_230632",
"access_code": null,
"booking_fee": 0,
"description": null,
"group_id": "tg_21100",
"max_per_order": 100,
"min_per_order": 1,
"name": "4.21 Senior (62+) - Presale",
"price": 600,
"status": "on_sale",
"sort_order": 50101,
"type": "paid",
"quantity": 10000,
"quantity_held": 0,
"quantity_issued": 1000,
"quantity_total": 11000
}
],
"tickets_available": "true",
"tickets_available_at": 1893511380,
"tickets_available_at_message": "Tickets are available in {countdown}",
"tickets_unavailable_at": 1893511381,
"tickets_unavailable_at_message": "Tickets are no longer available",
"timezone": "Europe/London",
"total_holds": 0,
"total_issued_tickets": 2,
"total_orders": 1,
"transaction_fee_fixed_amount": null,
"transaction_fee_percentage": 10,
"unavailable": "false",
"unavailable_status": null,
"url": "https://www.tickettailor.com/events/flowerfestival/40980",
"venue": {
"country": "GB",
"name": "Flower festival gardens",
"postal_code": "SW1 3BR"
},
"voucher_ids": [
"vo_123",
"vo_345"
],
"waitlist_active": "true",
"waitlist_call_to_action": "Join waiting list",
"waitlist_event_page_text": "Description above ticket waitlist form",
"waitlist_confirmation_message": "Done! You are on the waiting list."
}
],
"links": {
"next": "/v1/events?starting_after=ev_123",
"previous": "/v1/events?ending_before=ev_100"
}
}