latestOpenAPI 3.1.12026-08-108026304.2 KB

7b222e8ec91c

Event series

List event occurrences

For the given event series ID, find all the associated events and list them

get/v1/event_series/{event_series_id}/events

Query parameters

start_atinteger

Unix timestamp filter that returns items with matched start_at value.

start_at.gtinteger

Unix timestamp filter that returns items with start_at greater than given value.

start_at.gteinteger

Unix timestamp filter that returns items with start_at greater than or equal given value.

start_at.ltinteger

Unix timestamp filter that returns items with start_at less than given value.

start_at.lteinteger

Unix timestamp filter that returns items with start_at less than or equal given value.

end_atinteger

Unix timestamp filter that returns items with matched end_at value.

end_at.gtinteger

Unix timestamp filter that returns items with end_at greater than given value.

end_at.gteinteger

Unix timestamp filter that returns items with end_at greater than or equal given value.

end_at.ltinteger

Unix timestamp filter that returns items with end_at less than given value.

end_at.lteinteger

Unix timestamp filter that returns items with end_at less than or equal given value.

starting_afterstring

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.

ending_beforestring

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.

limitstring

The number of items to retrieve

override_idstring

A string representing the event override ID

Response

Successfully returned list of event occurrences

Example response

{
  "data": [
    {
      "object": "event",
      "id": "ev_1",
      "available_status": "This event occurrence is available",
      "bundles": [],
      "chk": "da09",
      "currency": "gbp",
      "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
      },
      "event_series_id": "es_1",
      "hidden": "true",
      "online_link": null,
      "override_id": "ov_123",
      "revenue": 155,
      "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
      },
      "max_tickets_sold_per_occurrence": null,
      "tickets_available": "true",
      "ticket_groups": [
        {
          "object": "ticket_group",
          "id": "tg_21099",
          "bundle_ids": [
            "bu_1234"
          ],
          "max_per_order": 100,
          "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": 100,
          "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
        }
      ],
      "total_issued_tickets": 5,
      "transaction_fee_fixed_amount": null,
      "transaction_fee_percentage": 10,
      "unavailable": "true",
      "unavailable_status": "This event occurrence is not available",
      "url": "https://www.tickettailor.com/checkout/view-event/id/123/chk/abcd/"
    }
  ],
  "links": {
    "next": "/v1/event_series/es_123/events?starting_after=ev_120",
    "previous": "/v1/event_series/es_123/events?ending_before=ev_100"
  }
}