latestOpenAPI 3.1.12026-08-108026304.2 KB
7b222e8ec91c
Event series
List event series
Returns all paginated event series
get/v1/event_series
Query parameters
created_atinteger
Unix timestamp filter that returns items with matched created_at value.
created_at.gtinteger
Unix timestamp filter that returns items with created_at greater than given value.
created_at.gteinteger
Unix timestamp filter that returns items with created_at greater than or equal given value.
created_at.ltinteger
Unix timestamp filter that returns items with created_at less than given value.
created_at.lteinteger
Unix timestamp filter that returns items with created_at less than or equal given value.
limitstring
The number of items to retrieve
status'published' | 'draft' | 'sales_closed'
A comma separated list of event series status. (e.g. draft, published)
namestring
A string representing the event name
venuestring
A string representing the event venue
Response
A successfully returned list of event series
Example response
{
"data": [
{
"object": "event_series",
"id": "es_1",
"access_code": null,
"bundles": null,
"call_to_action": "Buy tickets / Join the guestlist",
"currency": "gbp",
"default_max_tickets_sold_per_occurrence": null,
"default_ticket_groups": [
{
"object": "ticket_group",
"id": "tg_21099",
"bundle_ids": [
"bu_123"
],
"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": [
"bu_4"
],
"max_per_order": 10,
"max_quantity": 100,
"min_per_order": 1,
"name": "April 21st",
"sort_order": 50100,
"ticket_ids": [
"tt_230631",
"tt_230632"
]
}
],
"default_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
}
],
"description": null,
"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"
},
"name": "Hackney Downs 2020 Tulip Festival",
"next_occurrence_date": {
"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
},
"online_event": "false",
"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": 165,
"sales_tax_label": "VAT",
"sales_tax_percentage": 20,
"sales_tax_treatment": "exclusive",
"show_map": "true",
"status": "published",
"timezone": "Europe/London",
"total_occurrences": 20,
"total_issued_tickets": 5,
"transaction_fee_fixed_amount": null,
"transaction_fee_percentage": 10,
"tickets_available_at": {
"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
},
"tickets_available_at_message": "Tickets are available in {countdown}",
"tickets_unavailable_at": {
"date": "2020-05-02",
"formatted": "Sat 2 May 2020 10:30 PM",
"iso": "2020-05-02T22:30:00+01:00",
"time": "22:30",
"timezone": "+01:00",
"unix": 1588455000
},
"tickets_unavailable_at_message": "Tickets are no longer available",
"upcoming_occurrences": 5,
"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",
"vo_567"
],
"waitlist_active": "true",
"waitlist_call_to_action": "Join waiting list",
"waitlist_event_page_text": "Join our waiting list to be notified when tickets become available.",
"waitlist_confirmation_message": "Done! You are on the waiting list."
}
],
"links": {
"next": "/v1/event_series?starting_after=es_120",
"previous": "/v1/event_series?ending_before=es_100"
}
}