latestOpenAPI 3.1.12026-08-108026304.2 KB

7b222e8ec91c

Events

Retrieve an event

Returns an event belonging to the box office.

get/v1/events/{event_id}

Path parameters

event_idstring required

The unique identifier for the event

Response

A successfully returned event

objectstring

idstring

A unique identifier for the event

available_statusstring nullable

Optional custom status message when event is set to be available

chkstring

Used for Ticket Tailor checkout chk value

access_codestring nullable

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

currency'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'

Information about the currency the event is configured to use

descriptionstring nullable

Description of the event

event_series_idstring

Recurring events are grouped by an event_series_id

hiddenstring

True, if event is set to hidden

max_tickets_sold_per_occurrenceinteger nullable

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

online_linkstring nullable

URL of the online event

override_idinteger nullable

A unique identifier for the associated override

privatestring

Returns whether or not the event is private

revenuenumber

Total revenue of the event

sales_tax_labelstring nullable

The label for the sales tax

sales_tax_percentageinteger nullable

The percentage of the sales tax

sales_tax_treatment'inclusive' | 'exclusive' nullable

The treatment of the sales tax

show_mapstring

Returns whether or not the map should be shown on the event page. It depends if venue location is set and if the event is not online and hide map is not set in the event series.

status'draft' | 'published' | 'sales_closed'

Status of the event

tickets_availablestring nullable

Are there any ticket types available?

tickets_available_atinteger nullable

Timestamp in UTC in seconds when tickets become available for purchase

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_atinteger nullable

Timestamp in UTC in seconds when tickets become unavailable for purchase

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

transaction_fee_fixed_amountinteger nullable

Fixed amount of the transaction fee

transaction_fee_percentageinteger nullable

Percentage of the transaction fee

unavailablestring

True, if event is set to unavailable

unavailable_statusstring nullable

optional custom status message when event is set to be unavailable

urlstring

Event page URL

voucher_idsstring[]

List of voucher IDs

waitlist_active'true' | 'no_tickets_available' | 'false'

Indicates whether waitlist is enabled for the event series

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

Example response

{
  "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."
}