One event with its dates and ticket types
https://api.app2email.com/v1/{number}/tickets/events/{id} Scope: tickets:manage. By id, slug or code (EV-XXXXX). With its scheduled dates (soonest first, at most 50; dates_more says there are more, and GET /tickets/events/{id}/dates pages through all of them), its ticket types that are not archived and, for a draft, problems: what still stops publishing (empty: it can be published).
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The event: its id, its slug (eg summer-quiz) or its code (EV-XXXXX).
e.g.summer-quiz
Responses
Fields
- success boolean
- request_id string
- event object
An event with its options and what is sold. Money is a number in the event's currency plus a label such as "A$12.00".
37 fields
- id integer
The event's id.
e.g.12 - slug string
The last part of the event's address.
e.g.summer-quiz - code string
The short code people can send in the WhatsApp chat to open this event.
e.g.EV-7H3KQ - name stringe.g.
Summer Quiz - summary string
One line under the name (up to 160 characters).
- description string
- status string
draft: not on sale yet. ended: no scheduled date is left.
draftpublishedendedcancelled - sales string
onpaused - visibility string
unlisted: not in the list of the number's events; the link works.
publicunlisted - schedule string
single: one date. dates: several dates. slots: timed entry.
singledatesslots - seating string
map: buyers pick seats on a seat plan.
nonemap - archived boolean
- timezone string
IANA time zone of the event's times.
e.g.Australia/Sydney - currency string
ISO 4217.
e.g.AUD - capacity integer
People per date. 0 = no limit. Not used with a seat plan.
- held_back integer
Places per date only the business's staff can sell.
- url string
The buyers' page of the event. It shows the event only while it is published.
- cover_url string
The first picture of the event, 800 pixels wide. Empty when it has none.
-
The event's options with every default filled in: doors_min, sales_end, sales_end_min, place, venue {name, address, map, lat, lng, pin, note, hide_address}, online {url, note}, age, age_text, access_info, max_per_order, max_per_buyer, show_remaining, fee {ticket_minor, order_minor, show}, tax {rate, label, inclusive}, donation {enabled, amounts}, checkout {email}, names, questions, terms_text, terms_url, marketing_optin, seat {pick, no_single}, reminders, reminder_note, holder_changes, refund_policy, refund_days, refund_text, waitlist, door {opens_min, reentry, gates [{id, name, type_ids}]}, brand {color}, ticket_style. Amounts inside it (fee.ticket_minor, fee.order_minor, donation.amounts) are whole numbers in the smallest unit of the currency, as stored: the one place of this API where money is not a decimal number.
- from_price number | null
The lowest all-in price of a public ticket type. null when there is none, or it was not read.
- from_price_label string
- tickets_sold integer | null
Valid tickets of all dates (extras not counted).
- dates_count integer | null
Dates that are scheduled.
- next_date object
The next scheduled date. null when there is none.
18 fields
- id integer
The date's id.
e.g.31 - event_id integer
The event it belongs to.
e.g.12 - start string (date-time)
When it starts (UTC).
- end string (date-time)
When it ends (UTC).
- start_local string
The start as clock time in the event's time zone (yyyy-MM-ddTHH:mm).
e.g.2026-12-12T19:30 - end_local string
The end as clock time in the event's time zone.
e.g.2026-12-12T21:30 - label string
A short name of the date, eg Late show. Empty when it has none.
- capacity integer | null
How many people fit: the date's own limit, else the event's; with a seat plan the places of the plan. null = no limit.
- sales string
paused: nothing is sold for this date right now.
onpaused - status string
scheduledendedcancelled - sold integer | null
Valid tickets (extras not counted). The five counts sold, people, held, left and checked_in are null inside webhook events, in the door list and in next_date of the events list.
- people integer | null
The people those tickets admit (a group ticket admits several).
- held integer | null
People in baskets right now.
- left integer | null
People that can still be sold. null = no limit, or the counts were not read.
- checked_in integer | null
People admitted at the door.
- sold_out boolean
The date sold its last public ticket and no place has come back since.
- changed string (date-time) | null
When the time or the venue last changed and ticket holders were told.
- cancelled string (date-time) | null
When the date was cancelled.
- seat_plan object | null
null without a seat plan. Seat plans are drawn on the dashboard.
- sales_start string (date-time) | null
When buyers can start to buy. null = from the moment it is published.
- published string (date-time) | null
When it was first published.
- ended string (date-time) | null
- cancelled string (date-time) | null
- cancel_reason string
- created_by string
Who made it: a person of the business, or API key <name>.
- created string (date-time)
- updated string (date-time)
- dates object[]
Only in answers with ONE event: its scheduled dates, soonest first, at most 50.
18 item fields
- id integer
The date's id.
e.g.31 - event_id integer
The event it belongs to.
e.g.12 - start string (date-time)
When it starts (UTC).
- end string (date-time)
When it ends (UTC).
- start_local string
The start as clock time in the event's time zone (yyyy-MM-ddTHH:mm).
e.g.2026-12-12T19:30 - end_local string
The end as clock time in the event's time zone.
e.g.2026-12-12T21:30 - label string
A short name of the date, eg Late show. Empty when it has none.
- capacity integer | null
How many people fit: the date's own limit, else the event's; with a seat plan the places of the plan. null = no limit.
- sales string
paused: nothing is sold for this date right now.
onpaused - status string
scheduledendedcancelled - sold integer | null
Valid tickets (extras not counted). The five counts sold, people, held, left and checked_in are null inside webhook events, in the door list and in next_date of the events list.
- people integer | null
The people those tickets admit (a group ticket admits several).
- held integer | null
People in baskets right now.
- left integer | null
People that can still be sold. null = no limit, or the counts were not read.
- checked_in integer | null
People admitted at the door.
- sold_out boolean
The date sold its last public ticket and no place has come back since.
- changed string (date-time) | null
When the time or the venue last changed and ticket holders were told.
- cancelled string (date-time) | null
When the date was cancelled.
- dates_more boolean
Only with dates: there are more than 50; GET /tickets/events/{id}/dates pages through all of them.
- types object[]
Only in answers with ONE event: its ticket types that are not archived, in their order.
29 item fields
- id integer
The ticket type's id.
e.g.44 - event_id integere.g.
12 - name stringe.g.
Adult - description string
- role string
ticket: admits people. addon: an extra such as parking or a drink voucher, bought with a ticket.
ticketaddon - status string
archived: offered nowhere any more; the tickets sold stay valid.
activearchived - visibility string
hidden: buyers see it only with a code that unlocks it.
publichidden - sort integer
The place in the list, lowest first.
- price_mode string
choose: the buyer names the amount, from min_price.
fixedchoose - price number
The price as the organiser typed it, in the event's currency.
e.g.12 - price_label stringe.g.
A$12.00 - price_all_in number
What a buyer pays for one, booking fee and tax included.
e.g.12 - price_all_in_label stringe.g.
A$12.00 - min_price number
price_mode choose: the least amount. 0 otherwise.
- admits integer
How many people one ticket admits (1 to 20).
- quantity integer
How many can be sold per date. 0 = no limit of its own.
- pool_id integer
The shared capacity it draws from. 0 = none.
- opens_after integer
The ticket type that must sell out before this one goes on sale. 0 = none.
- needs integer
The ticket type that must be in the same order. 0 = none.
- needs_each boolean
true: one of
needsfor each of these. - min_per_order integer
- max_per_order integer
0 = the event's order limit.
- sales_start string (date-time) | null
When its sale opens. null = with the event.
- sales_end string (date-time) | null
When its sale ends. null = with the event's rule.
- sales_end_days integer
Its sale ends this many days before each date. 0 = not used.
- date_ids integer[]
The dates it is sold for. [] = every date.
- door_note string
A note the door sees, eg Check student card.
- created string (date-time)
- updated string (date-time)
- problems string[]
Only in answers with ONE event that is a draft: what still stops publishing, one sentence each. Empty: it can be published.
- started boolean
Only after a cancel: the refunds run in the background.
- note string
What happened, in one sentence.
Errors
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.