List all events

GET https://api.tickettailor.com/v1/events

Returns a list of events belonging to the box office.

Request

Query Parameters

start_at integer

Unix timestamp filter that returns items with matched start_at value.

start_at.gt integer

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

start_at.gte integer

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

start_at.lt integer

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

start_at.lte integer

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

end_at integer

Unix timestamp filter that returns items with matched end_at value.

end_at.gt integer

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

end_at.gte integer

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

end_at.lt integer

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

end_at.lte integer

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

starting_after string

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_before string

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.

limit string

The number of items to retrieve

status string

Possible values: [published, draft, sales_closed]

A comma separated list of event series status. (e.g. draft,published)

Responses

200
default

A successfully returned list of events

application/json

Schema
Example (auto)

Schema

data object[]

Array [

objectstring

idstring

A unique identifier for the event

chkstring

Used for Ticket Tailor checkout chk value

access_codestringnullable

Code to access a protected event

call_to_actionstring

Call to action text used on the event page

checkout_urlstring

Event checkout URL

created_atinteger

currencystring

Information about the currency the event is configured to use

Possible values: [gbp, usd, eur, sgd, aud, brl, cad, czk, dkk, hkd, huf, ils, jpy, myr, mxn, nok, nzd, php, pln, rub, sek, chf, twd, thb, try]

descriptionstringnullable

Description of the event

end

event_series_idstring

Recurring events are grouped by an event_series_id

hiddenstring

True, if event is set to hidden

Possible values: [true, false]

images

max_tickets_sold_per_occurrenceintegernullable

Maximum quantity of tickets that can be sold across all ticket types

namestring

Name of the event

online_eventstring

Returns whether or not the event is online

Possible values: [true, false]

override_idintegernullable

A unique identifier for the associated override

payment_methods undefined[]

privatestring

Returns whether or not the event is private

Possible values: [true, false]

revenuenumber

Total revenue of the event

start

statusstring

Status of the event

Possible values: [draft, published, sales_closed]

ticket_groups undefined[]

ticket_types object[]nullable

Array [

objectstringrequired

idstringrequired

A unique identifier for the ticket type

access_codestringnullablerequired

Code to access a hidden ticket

booking_feeintegerrequired

Optional booking fee which is charged per ticket type to the customer and the funds are paid to you.

descriptionstringnullablerequired

discountsstring[]

An array of associated discounts

group_idstringnullablerequired

ID of the group this ticket type belongs to

has_overridesstring

Specifies whether the ticket type has overrides

Possible values: [true, false]

hide_after objectnullable

hide_until objectnullable

hide_when_sold_outstring

Specifies whether the ticket is hidden when it has sold out

Possible values: [true, false]

max_per_orderintegerrequired

Maximum number of ticket types you can select per order

min_per_orderintegerrequired

Minimum number of ticket types you can select per order

namestringrequired

Name of the ticket type

override_idstringnullable

The ID of the override associated with the ticket type

price objectrequired

show_quantity_remainingstring

Specifies whether to show the number of tickets still available

Possible values: [true, false]

show_quantity_remaining_less_thanintegernullable

Only show number of tickets still available when the available quantity is equal to or lower than this threshold

statusstringrequired

Status of the ticket type

Possible values: [on_sale, sold_out, unavailable, hidden, admin_only, locked]

sort_orderintegerrequired

Sort index of ticket type in the UI

typestringrequired

Possible values: [paid, free]

quantityintegerrequired

Number available for purchase

quantity_heldintegerrequired

Number held

quantity_in_basketsinteger

Number in baskets

quantity_issuedintegerrequired

Number issued

quantity_totalintegerrequired

Total number including issued and still available

]

tickets_availablestringnullable

Are there any ticket types available?

Possible values: [true, false]

tickets_available_atintegernullable

Timestamp in UTC in seconds when tickets become available for purchase

Example: 1893511380

tickets_available_at_messagestring

Message to show when tickets are not yet available to purchase. {countdown} is replaced with time remaining until tickets become available

tickets_unavailable_atintegernullable

Timestamp in UTC in seconds when tickets become unavailable for purchase

Example: 1893511380

tickets_unavailable_at_messagestring

Message to show when tickets are unavailable to purchase

timezonestring

TZ format timezone string

total_holdsinteger

Total number of holds

total_issued_ticketsinteger

Total number of issued tickets

total_ordersinteger

Total number of orders

unavailablestring

True, if event is set to unavailable

Possible values: [true, false]

unavailable_statusstringnullable

optional custom status message when event is set to be unavailable

urlstring

Event page URL

venue

voucher_idsstring[]

List of voucher IDs

waitlist_activestring

Indicates whether waitlist is enabled for the event series

Possible values: [true, no_tickets_available, false]

waitlist_call_to_actionstring

The text displayed on event action buttons and as a title above the waitlist format

waitlist_event_page_textstring

Description above ticket waitlist form

waitlist_confirmation_messagestring

Text shown to the user after they have signed up to the waitlist

]

links object

{
  "data": [
    {
      "object": "event",
      "id": "ev_1",
      "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",
      "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,
      "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": [
        {
          "id": "tg_21099",
          "max_per_order": null,
          "name": "April 20th",
          "sort_order": 50050,
          "ticket_ids": [
            "tt_230625",
            "tt_230626"
          ]
        },
        {
          "id": "tg_21100",
          "max_per_order": null,
          "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,
      "unavailable": "false",
      "unavailable_status": null,
      "url": "https://www.tickettailor.com/events/flowerfestival/40980",
      "venue": {
        "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"
  }
}

Error schema

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Http status code

error_codestringrequired

Readable error code

messagestringrequired

Detailed error message

errors object[]

{
  "status": 0,
  "error_code": "string",
  "message": "string",
  "errors": [
    {
      "field": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Authorization: http

name: BasicAuthtype: httpdescription: Use base64 encoded api key created in Ticket Tailor dashboard.
scheme: basic

CURL

curl -L 'https://api.tickettailor.com/v1/events' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'

List all events

https://api.tickettailor.com/v1/events

Request​

Query Parameters

Responses​

Authorization: http

Request

Responses