---
title: "List all events"
method: GET
path: "/v1/events"
tags: ["Events"]
---

# List all events

`GET /v1/events`

Returns a list of events belonging to the box office.

## Query parameters

- `start_at` integer
- `start_at.gt` integer
- `start_at.gte` integer
- `start_at.lt` integer
- `start_at.lte` integer
- `end_at` integer
- `end_at.gt` integer
- `end_at.gte` integer
- `end_at.lt` integer
- `end_at.lte` integer
- `starting_after` string
- `ending_before` string
- `limit` string
- `status` 'published' | 'draft' | 'sales_closed'
- `name` string
- `venue` string

## Response `200`

A successfully returned list of events

- object
  - `data` Event[]
    - `object` string
    - `id` string — A unique identifier for the event
    - `available_status` string, nullable — Optional custom status message when event is set to be available
    - `chk` string — Used for Ticket Tailor checkout chk value
    - `access_code` string, nullable — Code to access a protected event
    - `call_to_action` string — Call to action text used on the event page
    - `checkout_url` string — Event checkout URL
    - `created_at` integer
    - `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
    - `description` string, nullable — Description of the event
    - `end` object
      - `date` string — ISO-8601 date for the end of the event
      - `formatted` string — A formatted date string for the end of the event
      - `iso` string — ISO-8601 date and time for the end of the event
      - `time` string — Time of the end of the event
      - `timezone` string — Timezone offset for the end of the event
      - `unix` integer — Unix timestamp for for the end of the event
    - `event_series_id` string — Recurring events are grouped by an event_series_id
    - `hidden` string — True, if event is set to hidden
    - `images` object — Images that have been uploaded to this event
      - `header` string — Image URL of the header image used on your event page
      - `thumbnail` string — Image URL of the thumbnail used on your event page
    - `max_tickets_sold_per_occurrence` integer, nullable — Maximum quantity of tickets that can be sold across all ticket types
    - `name` string — Name of the event
    - `online_event` string — Returns whether or not the event is online
    - `online_link` string, nullable — URL of the online event
    - `override_id` integer, nullable — A unique identifier for the associated override
    - `payment_methods` object[] — An array of payment methods
      - `external_id` string — A unique identifier for the payment method
      - `id` string — A unique identifier for internal payment methods
      - `type` 'stripe' | 'paypal' | 'offline' — The type of payment method
      - `name` string — Name of the payment method
      - `instructions` string — Instructions for the customer on how to pay. Used for offline payments.
    - `private` string — Returns whether or not the event is private
    - `revenue` number — Total revenue of the event
    - `sales_tax_label` string, nullable — The label for the sales tax
    - `sales_tax_percentage` integer, nullable — The percentage of the sales tax
    - `sales_tax_treatment` 'inclusive' | 'exclusive', nullable — The treatment of the sales tax
    - `show_map` string — 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.
    - `start` object
      - `date` string — ISO-8601 date for the start of the event
      - `formatted` string — A formatted date string for the start of the event
      - `iso` string — ISO-8601 date and time for the start of the event
      - `time` string — Time of the start of the event
      - `timezone` string — Timezone offset for the start of the event
      - `unix` integer — Unix timestamp for the start of the event
    - `status` 'draft' | 'published' | 'sales_closed' — Status of the event
    - `ticket_groups` TicketGroup[], nullable
      - `object` string
      - `id` string — A unique identifier for the ticket group
      - `bundle_ids` string[], nullable — An array of associated bundle ids
      - `max_per_order` integer, nullable — Maximum number of tickets allowed per order
      - `max_quantity` integer, nullable — Maximum quantity of tickets that are allowed to be sold for the tickets in the group
      - `min_per_order` integer, nullable — Minimum number of tickets allowed per order
      - `name` string — Name of the ticket group
      - `sort_order` integer — Sort index of the group in the UI
      - `ticket_ids` string[] — An array of associated ticket type ids
    - `ticket_types` TicketType[], nullable
      - `object` string, required
      - `id` string, required — A unique identifier for the ticket type
      - `access_code` string, nullable, required — Code to access a hidden ticket
      - `booking_fee` integer, required — Optional booking fee which is charged per ticket type to the customer and the funds are paid to you.
      - `description` string, nullable, required
      - `discounts` string[] — An array of associated discounts
      - `group_id` string, nullable, required — ID of the group this ticket type belongs to
      - `has_overrides` 'true' | 'false' — Specifies whether the ticket type has overrides
      - `hide_after` object, nullable — Timestamp in seconds when the ticket type should be hidden until.
        - `date` string — ISO-8601 date for the start of the event
        - `formatted` string — A formatted date string for the start of the event
        - `iso` string — ISO-8601 date and time for the start of the event
        - `time` string — Time for the start of the event
        - `timezone` string — Timezone offset for the start of the event
        - `unix` integer — Unix timestamp for the start of the event
      - `hide_until` object, nullable — Timestamp in seconds when the ticket type should be hidden after.
        - `date` string — ISO-8601 date for the start of the event
        - `formatted` string — A formatted date string for the start of the event
        - `iso` string — ISO-8601 date and time for the start of the event
        - `time` string — Time for the start of the event
        - `timezone` string — Timezone offset for the start of the event
        - `unix` integer — Unix timestamp for the start of the event
      - `hide_when_sold_out` 'true' | 'false' — Specifies whether the ticket is hidden when it has sold out
      - `max_per_order` integer, required — Maximum number of ticket types you can select per order
      - `min_per_order` integer, required — Minimum number of ticket types you can select per order
      - `name` string, required — Name of the ticket type
      - `override_id` string, nullable — The ID of the override associated with the ticket type
      - `price` union, required — Cost of the ticket type
        - integer
        - number
      - `show_quantity_remaining` 'true' | 'false' — Specifies whether to show the number of tickets still available
      - `show_quantity_remaining_less_than` integer, nullable — Only show number of tickets still available when the available quantity is equal to or lower than this threshold
      - `status` 'on_sale' | 'sold_out' | 'unavailable' | 'hidden' | 'admin_only' | 'locked', required — Status of the ticket type
      - `sort_order` integer, required — Sort index of ticket type in the UI
      - `type` 'paid' | 'free', required
      - `quantity` integer, required — Number available for purchase
      - `quantity_held` integer, required — Number held
      - `quantity_in_baskets` integer — Number in baskets
      - `quantity_issued` integer, required — Number issued
      - `quantity_total` integer, required — Total number including issued and still available
    - `tickets_available` string, nullable — Are there any ticket types available?
    - `tickets_available_at` integer, nullable — Timestamp in UTC in seconds when tickets become available for purchase
    - `tickets_available_at_message` string — Message to show when tickets are not yet available to purchase. {countdown} is replaced with time remaining until tickets become available
    - `tickets_unavailable_at` integer, nullable — Timestamp in UTC in seconds when tickets become unavailable for purchase
    - `tickets_unavailable_at_message` string — Message to show when tickets are unavailable to purchase
    - `timezone` string — TZ format timezone string
    - `total_holds` integer — Total number of holds
    - `total_issued_tickets` integer — Total number of issued tickets
    - `total_orders` integer — Total number of orders
    - `transaction_fee_fixed_amount` integer, nullable — Fixed amount of the transaction fee
    - `transaction_fee_percentage` integer, nullable — Percentage of the transaction fee
    - `unavailable` string — True, if event is set to unavailable
    - `unavailable_status` string, nullable — optional custom status message when event is set to be unavailable
    - `url` string — Event page URL
    - `venue` object
      - `country` string, nullable — Country of the venue
      - `name` string, nullable — Name of the venue
      - `postal_code` string, nullable — Postal code of the venue
    - `voucher_ids` string[] — List of voucher IDs
    - `waitlist_active` 'true' | 'no_tickets_available' | 'false' — Indicates whether waitlist is enabled for the event series
    - `waitlist_call_to_action` string — The text displayed on event action buttons and as a title above the waitlist format
    - `waitlist_event_page_text` string — Description above ticket waitlist form
    - `waitlist_confirmation_message` string — Text shown to the user after they have signed up to the waitlist
  - `links` object
    - `next` string, nullable
    - `previous` string, nullable

## Other responses

- `default` — Error schema

---

[API](https://skmtc.net/tickettailor/apis/ticket-tailor-api.md) · [All operations](https://skmtc.net/tickettailor/apis/ticket-tailor-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tickettailor/ticket-tailor-api/revisions/7b222e8ec91c/schema)