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:

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, booking, booking.lead, booking.eventType, booking.invoices. Requesting any booking.* path auto-promotes booking. 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, 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.

booking
object

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