Events

Get an event

The event with its booked rooms (spaces), its slots, the company, venue and contact both nested (companies, locations, people) and flat (company_name, venue_name, contact_*), and the public BEO link. Amounts are null without reports.view or quotes.manage. Role permission: none (any member).

get/events/{id}

Request

  • Base URL: https://joinways.app/api/v1
  • URL: https://joinways.app/api/v1/events/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://joinways.app/oauth/authorize, token URL https://joinways.app/api/oauth/token, scopes: mcp.read)

Response

The event.

idstring uuid
account_idstring uuid
event_numberinteger nullable
internal_referencestring nullable
titlestring
descriptionstring nullable
typestring nullable
categorystring nullable
status'option' | 'confirmed' | 'lost' | 'cancelled'

option = pending / tentative, confirmed = booked, lost = did not convert, cancelled = cancelled after booking.

status_changed_atstring date-time nullable
stage_idstring uuid nullable
stage_changed_atstring date-time nullable
paxinteger nullable
start_datestring date-time
end_datestring date-time nullable
selected_datesstring[] nullable
timezonestring nullable
is_virtualboolean nullable
flexibleboolean nullable
languagestring nullable
venue_idstring uuid nullable

The venue (internally location_id).

locationstring nullable

Free-text place (legacy), not the venue.

addressstring nullable
citystring nullable
postal_codestring nullable
countrystring nullable
sourcestring nullable
source_lead_idstring uuid nullable

Primary request (lead) of the event.

budgetnumber nullable
expected_revenuenumber nullable
currencystring nullable
confirmed_amountnumber nullable
confirmed_amount_excl_taxnumber nullable
cancellation_fee_excl_taxnumber nullable
confirmed_atstring date-time nullable
loss_reasonstring nullable
loss_reason_detailstring nullable
cancellation_reasonstring nullable
cancellation_reason_detailstring nullable
tagsstring[] nullable
notesstring nullable
company_idstring uuid nullable
contact_person_idstring uuid nullable
assigned_to_account_idstring uuid nullable
created_bystring uuid nullable
billing_company_idstring uuid nullable

Third-party company the quotes are billed to (instead of the client).

quote_to_platformboolean nullable

The quotes are billed to the booking platform of source.

event_group_idstring uuid nullable
external_linkstring nullable
setup_typestring nullable
setup_notesstring nullable
catering_notesstring nullable
dietary_notesstring nullable

Diets and allergies (« Contraintes alimentaires »), for the whole event.

technical_notesstring nullable
service_notesstring nullable
beo_contextstring nullable
beo_remarksstring nullable
scheduleobject[] nullable

BEO program lines (see BeoUpdate.schedule).

beo_public_urlstring uri nullable

Shareable, no-login URL of the public BEO page.

archived_atstring date-time nullable
archived_bystring uuid nullable
created_atstring date-time nullable
updated_atstring date-time nullable
company_namestring nullable
venue_namestring nullable
contact_first_namestring nullable
contact_last_namestring nullable
contact_emailstring nullable
contact_phonestring nullable

Example response

{
  "status": "confirmed",
  "day_hours": [
    {
      "date": "2026-11-12",
      "start": "09:00",
      "end": "18:00"
    },
    {
      "date": "2026-11-13",
      "start": "19:00",
      "end": "02:00"
    }
  ],
  "beo_public_url": "https://joinways.app/beo/8f3c2a1e-…",
  "company_name": "Acme",
  "venue_name": "Le Grand Salon",
  "slots": [
    {
      "space_name": "Plénière",
      "day_date": "2026-10-16",
      "start_time": "09:00",
      "end_time": "12:30",
      "label": "Séminaire"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.