API reference

Generated HTTP contracts used by Xperience's first-party applications.

Production now serves API 6.2.0, which adds visitor survey insights for exhibitors: per-question totals of the event's visitor survey, with no individual answers. API 6.1.0 added optional per-scan rejection details and independent offline scanner settlement.

API 6.0.0 requires a saved company/event exhibitor survey response before lead CSV downloads. Scanning and CRM viewing remain available, and existing responses count. API 5.1.0 added an optional ageRange to the account profile and onboarding save. API 5.0.0 changed visitor submission to survey-only, removing new prize allocation while preserving responses and earlier redemption. API 4.13.0 adds nextDay to Complete & Spin's GET /api/spin/me and stops POST /api/spin spending a visitor's entry when today's prizes are gone but a later day has some. API 4.12.0 lets organisers invite an exhibitor company together with its booth crew. API 4.11.0 adds the arrivals-by-half-hour series, an optional day filter and crew emails to the event summary. API 4.10.1 changes Complete & Spin to one entry per person per event instead of per KL day. API 4.10.0 lets organisers invite and see exhibitor crew for companies assigned to their event, and adds event-wide totals to the exhibitor list. API 4.9.1 lets registered visitors use Complete & Spin without checking in first. API 4.9.0 adds Surveys, MATRADE-aligned exhibitor, conference and visitor surveys with results and CSV export. API 4.8.0 adds Complete & Spin, an exit survey with weighted daily prizes and counter redemption. API 4.7.0 adds an optional eventSlug on the signed ticket, so a pass can link to event privacy settings, and the capturing crew member on exhibitor leads. API 4.6.0 added MATRADE claim readiness, alongside self-serve organiser workspace creation, direct organiser appointment requests, and event/company context on appointment records. The read-only People directory remains available.

The public organiser API is not offered to third parties. These operations serve Xperience's first-party applications; documenting a route does not grant access. Protected operations still enforce the session, origin, live role, tenant, organiser, or scanner authority shown in the generated schema.

The machine-readable contract at GET /api/openapi is generated from the same concrete Zod Endpoint schemas used by the API. Swagger UI and /openapi.json consume that document rather than decorator-inferred empty DTOs.

Conventions

Contract versionSemver for the HTTP contract only; production serves 6.0.0.
TimesISO 8601, UTC. Rendered in Asia/Kuala_Lumpur.
MoneyInteger cents, never floats, with an explicit currency where applicable.
Phone numbersE.164 (+60123456789) after normalisation.
IdsUUID unless a field says it is a slug, signed code, or provider reference.
MutationsExact configured Origin required; direct Nest POST success is normally 201.

Deployment status

The production API serves contract 6.0.0, used by the promoted first-party apps. The relative OpenAPI server URL means “the configured origin serving this document”. Publishing this reference does not make the first-party API a third-party offering.

The deployed 6.0.0 contract requires a saved exhibitor survey response before lead CSV download. This is a major eligibility change: authorised owners/managers without a response receive a typed 403 before any CSV content. Any existing response for the same company and event counts, even after question edits or closure. Scanning, CRM viewing and visitor consent checks are preserved. Production health, database connectivity and the generated OpenAPI contract were verified after deployment. A real exhibitor owner submit/download journey remains unverified because the available signed-in account has no company.

The 5.1.0 candidate adds an optional ageRange (under_18, 18_24, 25_34, 35_44, 45_54, 55_plus or null) to the account profile and to POST /api/account/onboarding, and age_range/age_range_at to the account export. Omitting ageRange on save keeps the stored answer, so older clients are unaffected; this is a minor change. See Account.

Version 5.0.0, deployed on 7 October 2026, removes prize allocation from visitor submission. The existing spin paths and response envelopes remain, with empty wheel/prize-stock arrays for new submissions. This is a major behaviour change for clients expecting a draw. Historical prize entries and authorised redemption remain available. See Visitor surveys.

The 4.12.0 candidate lets an organiser invite an exhibitor company together with its booth crew: POST /api/exhibitors/invitations accepts an optional crew list, the new POST /api/exhibitors/event/invitations/crew adds crew to a company invitation that is still pending, and GET /api/exhibitors/invitations returns each company invitation's crew and marks a waiting crew invitation awaitingCompany. All additions are optional, so this is a minor version. See Exhibitor CRM.

The 4.11.0 candidate extends GET /api/exhibition/summary for the Studio Analytics page: an optional day input (a KL calendar day), an optional arrivals series in 30-minute KL buckets and an optional crewEmail on each crew row. Existing fields keep their meaning. See Event analytics.

The 4.10.1 candidate changes Complete & Spin from one spin per person per KL day to one entry per person per event. POST /api/spin returns a visitor's existing non-voided entry from any day instead of spinning again, and GET /api/spin/me returns that entry on later days. An entry the organiser voided no longer blocks a new spin. There are no schema changes, so this is a patch.

The 4.10.0 candidate adds two organiser operations under /api/exhibitors/event/team (read an assigned company's on-site team, and invite a booth manager or crew member) and an optional summary, managerEmail and crewCount on GET /api/exhibitors/event. See Exhibitor CRM.

The 4.9.1 candidate removes the same-day check-in requirement from Complete & Spin: GET /api/spin/me no longer returns not_checked_in (the value stays in the schema for older clients) and POST /api/spin no longer refuses a registered visitor who has not been scanned in.

The 4.9.0 candidate adds Surveys: nine operations under /api/surveys for the organiser's exhibitor and conference surveys, per-question results, paginated responses and CSV export, an exhibitor's one response per company and event, and a public conference survey reached by an unguessable link token. Visitor results read from Complete & Spin entries. See Surveys.

The 4.8.0 candidate adds Complete & Spin: ten operations under /api/spin for a checked-in visitor's survey and one daily server-decided spin, counter lookup and redemption by ticket QR, organiser setup of prizes and daily quotas, live counts, entries, void and CSV export. See Complete & Spin.

The 4.7.0 candidate adds an optional eventSlug to GET /api/events/ticket and an optional capturedByName on each lead from GET /api/exhibitors/leads.

The 4.6.0 candidate adds MATRADE claim readiness: the organiser's endorsement reference and auditor, optional booth, registered-name, registration-number and excluded fields on exhibitor rows, and a counted input. See Contract 4.6.0.

The 4.5.0 candidate adds verified-email self-serve organiser workspace creation, with idempotent resume behaviour and the existing Studio organisation cookie and redirect outcome. It also adds direct organiser appointment requests and event/ company context on appointment records.

The 4.1.0 candidate adds optional category filtering to public crew opportunities. The 4.0.0 candidate adds platform-admin discovery moderation and source policy, organiser marketplace profiles, briefs, proposals, appointments, and consent-backed exhibitor CRM workflows. The generated OpenAPI document remains the executable source for request and response details; the pages here list the exact method and path coverage expected by the API contract tests.

The 4.3.0 candidate adds PWA booking with mandatory contact details and versioned terms acceptance, plus the signed-in contact email in booking state. Existing registration clients and MATRADE reporting fields remain available.

On this page