Skip to main content
GET
Get Event
Retrieves the event with the given id. By default the response includes the event’s own scalar fields plus the foreign-key ids for related objects (bookingId, locationId, eventBriefId). Relations are inlined only when requested via expand[]. Pass one or more expand[] query parameters to inline related objects. On this endpoint, paths are written as-is — no prefix.
Allow-listed expand paths:
Requesting any nested booking.* path automatically expands booking itself — you do not need to list booking separately.

Expanded response

With expand[]=booking.lead&expand[]=booking.invoices, the response inlines the nested objects under booking:

Invoice totals

Each invoice breaks its total into parts. All amounts, including total, are integers in cents. subtotal + gratuityAmount + serviceChargeAmount - discountAmount + taxAmount = total. These match the columns in the invoice CSV export.

Booking form answers

booking.formResponse returns the answers your customer gave on your booking form. It’s null when the booking has no booking form response, for example when it was booked without the booking form. Lead intake form answers aren’t included.
  • Answers are in form order: by page, then by question. Blank answers are left out.
  • response is the answer as stored, which can differ from how the dashboard shows it. Yes/no answers are "yes" or "no", and dates are yyyy-MM-dd.
  • Answers to questions you’ve since deleted from the form are still included.
  • To look up answers by booking ID, use List Events.

Checklists and tasks

checklists.tasks returns the event’s checklists with their tasks. Use it to send prep lists, packing amounts, or admin to-dos to another tool.
Each checklist’s type tells you where it shows up in Flashquotes: There’s no type query parameter. Filter the checklists array in your code. For example, to keep only event brief checklists:
  • An event can have more than one checklist of each type.
  • Checklists are oldest first. Deleted checklists are left out.
  • Event brief tasks are in brief order: by stage, then by position within the stage.
  • quantity and unit hold optional amounts, such as 4 and "bags". Both are null when not set.
  • completedAt is when the task was checked off, or null when it’s not done.
  • A checklist with no tasks returns "tasks": []. Without checklists.tasks, checklists have no tasks field.

Limits

  • Maximum 20 expand paths per request (duplicates are deduplicated).
  • Maximum nesting depth of 4 segments.
  • Unknown or malformed paths return 400.

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

id
string
required

The event id.

Query Parameters

expand[]
string[]

Inline related objects. Allow-listed paths: location, services, staff, addons, resources, checklists, checklists.tasks, booking, booking.lead, booking.eventType, booking.invoices, booking.formResponse. Requesting any booking.* path auto-promotes booking, and checklists.tasks auto-promotes checklists. Max 20 paths, max depth 4.

Response

Event retrieved successfully

Default response includes only the fields below plus foreign-key ids (bookingId, locationId, eventBriefId). Related objects (location, services, staff, addons, resources, checklists, booking) appear only when requested via expand[].

object
enum<string>
required
Available options:
event
id
string
required
locationId
string
required
bookingId
string | null
required
name
string
clientName
string
clientEmail
string
clientPhone
string
siteContactName
string
siteContactPhone
string
eventDescription
string
eventAddress
string
additionalLocationInfo
string
specialNotes
string
parkingLoadingInfo
string
serviceStartTime
string<date-time>
serviceEndTime
string<date-time>
staffNumber
integer
resourceNumber
integer
companyId
string
eventBriefId
string | null
eventBriefUrl
string | null

Public URL to view the event brief, or null if no brief exists.

createdAt
string<date-time>
updatedAt
string<date-time>
staffDressCode
string | null
customData
any

Arbitrary JSON metadata attached to the event.

multiDay
boolean
guestCount
integer | null
loadingTime
integer | null

Minutes.

setupTime
integer | null

Minutes.

breakdownTime
integer | null

Minutes.

unloadingTime
integer | null

Minutes.

shiftStartTime
string<date-time> | null
shiftEndTime
string<date-time> | null
specialPrepTime
integer | null

Minutes.

travelToEventTime
integer | null

Minutes.

travelFromEventTime
integer | null

Minutes.

tipJarAllowed
boolean
outdoors
boolean
location
object

Present only when expand[]=location (or data.location on list).

services
object[]

Present only when expanded.

staff
object[]

Present only when expanded.

addons
object[]

Present only when expanded.

resources
object[]

Present only when expanded.

checklists
object[]

Present only when checklists or checklists.tasks is expanded. The event's admin and event brief checklists, oldest first. Deleted checklists are left out.

booking
object

Present only when expanded (auto-promoted by any booking.* expand).