latestOpenAPI 3.1.12026-08-108026304.2 KB

7b222e8ec91c

Overrides

List event series overrides

Returns a paginated list of overrides

get/v1/event_series/{event_series_id}/overrides

Query parameters

limitstring

The number of items to retrieve

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.

reference_idstring

A string representing the referenced ticket typ or ticket group

reference_type'ticket' | 'ticket_group'

A string representing the reference type, either ticket or ticket_group

A string representing override status

Response

A successfully returned list of overrides

Example response

{
  "data": [
    {
      "object": "override",
      "id": "ov_123",
      "created_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
      },
      "max_sellable_tickets": 55,
      "name": "Test override",
      "override_lines": [
        {
          "price": 123,
          "quantity": 5,
          "reference_type": "ticket_type",
          "reference_id": "tt_123",
          "status": "ON_SALE"
        },
        {
          "price": 321,
          "quantity": 34,
          "reference_type": "ticket_group",
          "reference_id": "tg_123",
          "status": null
        }
      ]
    }
  ],
  "links": {
    "next": "/v1/event_series/es_123/overrides?starting_after=ov_120",
    "previous": "/v1/event_series/es_123/overrides?ending_before=ov_100"
  }
}