Fetch event by ID
Returns the full details of a single event, including status, venue, pricing, and contact information.
Use the include query parameter to sideload related resources (comma-separated). Available: event_bookings, proposal_alternatives, event_users, event_staff_members, event_staff_requests, contacts, notes, event_adjustments. Nested includes are also supported — e.g. ?include=event_bookings.event_add_ons will include add-ons within each booking. Other nested includes: event_bookings.event_extras, event_bookings.event_photobooth_background, event_bookings.event_booking_extra_categories, proposal_alternatives.event_adjustments. The event's customers are sideloaded via event_users — there is no customer include.
On a proposal with alternatives, starting_balance, deposit_amount_due and balance_amount_due add every alternative together, which is not a price the client pays. Read each alternative's totals instead.
Required permission: assigned_event_read or unassigned_event_read
Request
- Base URL: https://api.checkcherry.com
- URL: https://api.checkcherry.com/api/v1/events/{event_id}
- Auth: none declared. Required headers: Api-Key
Path parameters
Event ID
Query parameters
Related resources to sideload, comma-separated. The description lists what is available.
Headers
Your Integration Key
Response
event found
Changes
No recorded changes to this operation across all 2 revisions of this API.