This is the changelog of the Understory API.
All additions or changes to API endpoints, general usage updates, and behavior changes will be reflected below. Breaking changes will be high-lighted in line with our Breaking Changes policy and the affected APIs grace period will be noted.
See API Versioning to learn more.
Accounting API
- Added
corrects_entry_idandreverses_entry_idto journal entries. A correction keeps its original's kind and references;corrects_entry_idnames the original, andreverses_entry_idis also set when the correction takes the original back in full, such as the undo of a refund that failed after it was booked.
Accounting API
- Added the
COMPENSATIONjournal entry kind. It records part of the price paid back to the guest while the booking stands. It debitsBOOKING_PREPAYMENTwhen the booking's revenue is not yet recognised, or the newBOOKING_COMPENSATIONposting type when it is, and never reverses recognised revenue. Its amounts are gross, likeREFUND. - Added the
BOOKING_COMPENSATIONbooking posting type. - Journal entry kinds are now an extensible polymorphic type: new kinds are added without a new API version, so clients must not fail on a
kindthey do not recognise. See Breaking Changes.
Authentication
- Documented that access tokens must be cached and reused until they are about to expire, not requested per API call. See Access tokens.
- Added JavaScript and Python examples of a cached token helper to Authenticating with internal integration keys.
- Documented the difference between
401 Unauthorized(get a new token) and403 Forbidden(the token lacks a scope). - Documented that third-party integrations must refresh each account's tokens from one place, because exchanging a used refresh token can revoke them.
- Removed the
openidscope from the client credentials example. It has no effect without a signed-in user. - Fixed the Quickstart naming the wrong path for marketing consents.
Building with AI
- Added the Building with AI guide. It lists the machine-readable versions of these docs (
llms.txt, a Markdown version of every page, the OpenAPI description) and rules to paste into an AI coding assistant's project instructions. - Reorganized
llms.txtinto sections and added a summary of how to call the API. - Fixed the OpenAPI download links in OpenAPI Description so they also work in the Markdown version of the page.
Using the API
- Documented all error codes the API returns and their HTTP statuses in Errors, and when to retry.
- Rewrote Rate limits with how to back off and how to stay within the limits.
- Added the list of webhook event types.
- Documented the two kinds of date-time the API uses: instants with a UTC offset, and local times at the experience's location. See Dates and times. The previous text said all timestamps end in
Z, which was wrong for local times. - Fixed the Pagination JavaScript example, which never ran its loop, and corrected the stated page-size limits.
- Fixed the HTTP method list in Using the API, which named
UPDATEinstead ofPUT.
API Reference
- Added a summary of how the API works to the API Reference: base URL, authentication, token reuse, pagination, errors, rate limits and dates.
- Documented both OAuth2.0 flows and token reuse on the
OAuth2security scheme. - Documented the values of the error
codefield and that the list is extensible. - Added contact details for integration questions.
Apart from the Accounting API additions, these changes affect documentation only.
Orders API
- Added the
kindfield to refunds returned by Get refunds.REVERSALgives back money for something the guest no longer receives, such as a cancelled booking.COMPENSATIONgives back part of the price while the booking stands. - Added the optional
reasonfield to refunds. A compensation carries acategory(DEFECTorGOODWILL) and the host's owntext. - Added the
PRODUCTline item product type, withProductDetailscarrying the product'snameat the time of sale and itscatalogue_item_id. A booking order can holdPRODUCTlines, such as drinks or merchandise, next to its tickets and add-ons. They were previously returned asTICKETlines with an emptyexperience_id.
Accounting API
- Added the
PRODUCT_REVENUEposting type. It carries the revenue from products, such as drinks or merchandise, and like the other generic postings it has nobookingobject. - Posting types are now an extensible polymorphic type: new types are added without a new API version, so clients must not fail on a
typethey do not recognise. See Breaking Changes.
Accounting API
- Added the
VOUCHER_NUMBERS_EXHAUSTEDactivity detail code. The accounting system has run out of voucher numbers in the series named indetail. Postings fail until the series is extended there.
Accounting API
- Added an optional
gift_card_idtoSALE,REFUND,BREAKAGE,BREAKAGE_REVERSALandADJUSTMENTjournal entries. It names the gift card whose balance the entry moved: the card a sale was paid with, a refund was returned to, that expired or was reopened, or whose balance was adjusted. Look the card up with Get gift card by ID. It is set on entries booked from 2026-11-04 on.
Accounting API
- Added the
BREAKAGE_REVERSALjournal entry kind. It reverses a gift card's breakage when an expired card is reopened, and likeBREAKAGEit carries no VAT.
Accounting API
- The Accounting API no longer requires an accounting subscription. Every Understory account can now use it, as long as the access token has the
accounting.readoraccounting.writescope.
Availability API
- Updated Get Availabilities to leave out the events and timeslots a host has closed to new bookings, unless the host exempted the event.
- Updated Get Availability to answer a closed event with
available: false, even when every constraint inconstraintspasses, and a closed timeslot with404.
Event Availability API & Events API
- Updated Get Event Availability and List Event Availability to report
available: falsefor an event on a date the host has closed to new bookings, unless the host exempted the event, even when every constraint inconstraintspasses. Create Booking answers such an event with409andEVENT_NOT_ACTIVE, though itsstatestaysACTIVE. - Clarified that closing a date never changes the
stateof the events on it in the Events API: an event on a closed date staysACTIVE, soACTIVEalone does not mean the event can be booked; read its availability.
Accounting API
- Record journal entry activity answers
409withCONFLICTinstead of500when the journal entry was modified concurrently. Retry the request; with the sameactivity_idthe retry is idempotent.
Orders API
- Added the
INTEGRATIONtransaction provider to order transactions.INTEGRATIONindicates the booking came through a reseller integration, and the reseller collected the payment. These transactions were previously returned asUNKNOWN.
Experiences API
The content blocks endpoint is labelled Alpha. See API Versioning.
- Added Get content blocks under
GET /v1/experiences/{experienceId}/content-blocks. It returns an experience's content blocks in the order Understory's own storefront presents them, in the language negotiated viaAccept-Language, and is guarded byexperience.read. - A content block's
typesays how it is structured, and itshandlesays what it is about.TEXTcarries Markdowntextand aWHATS_INCLUDEDorNICE_TO_KNOWhandle.STEP_LISTcarries an optionaltitle, orderedstepswith atitle,descriptionandimage, and anITINERARYhandle. Blocks without content are omitted. - Both the block
typeand thehandleare extensible: new values are added without a new API version. Integrations must not fail on values they do not recognise.
Breaking Changes policy
- Documented that new values may be added to polymorphic types and enums marked as extensible, and that integrations must not fail on values they do not recognise. See Breaking Changes.
Bookings API
- Breaking change: Create Booking now requires
nameon aCOMPANYcustomer, and answers400without it. The endpoint isAlpha, so there is no grace period. - Fixed Create Booking answering
500instead of409withEVENT_PAST_CUTOFFafter the booking cutoff. - Added the
409codesEVENT_NOT_ACTIVE,NOT_ENOUGH_RESOURCESandEVENT_EXCLUSIVITY_LOCKEDto Create Booking.
Marketing API
- A marketing consent's
idis now documented as a plain string rather than a UUID; the API never enforced the UUID format. No response changed. It only affects you if you generate a typed client from the OpenAPI description or validateidas a UUID; treat it as an opaque string. See Get marketing consents.
Availability API
- Get Availabilities and Get Availability are now
POSTrather thanGET. Both are still reads with no side effects; the query moves into the request body so it can carry richer context later. from,to,cursorandlimitmove into that body, unchanged. The body is optional. Get Availability takes none yet.- Added a
filterobject withevent_ids,location_idsanddurations(ISO 8601, e.g.PT1H30M).
Availability API
A new API for reading when an experience can be booked. It supersedes Event Availability, which only ever described events: an experience selling timeslots across its operating hours had no availability to read at all. Both answer for the same experiences until Event Availability is deprecated on its own notice.
The endpoints are labelled Preview: the specification is published for feedback, and they cannot be called yet. See API Versioning.
- Added Get Availabilities and Get Availability, under
/v1/experiences/{experienceId}/availabilities. The list is windowed withfromandto, and paginated onnext. - An availability's
subjectis eitherEVENT, carryingevent_idand thesession_idof the sitting on show, orTIMESLOT, which has no event until someone books it. Both are addressed by an opaqueidand carrystart_time,end_timeandtimezone, named as on Session. TICKET_LIMITreports each ticket variant and add-on separately, inticket_variantsandaddon_variants, rather than the single smallest count Event Availability returns. Two variants can be limited by different resources, so one being exhausted says nothing about the other.- Added the
EXCLUSIVITYconstraint: an exclusively booked event keeps reporting its remaining seats while being unbookable to everyone but the booking that claimed it. availableanswers whether anything can still be sold, not whether a particular basket fits. Booking creation remains the authoritative check.- Timeslots are not bookable yet through the public API. Create Booking names an event, and a timeslot has none until someone books it.
- Guarded by
experience.read, the scope that already covers reading experiences, so an integration that reads experiences needs no new grant.
Event Availability API
Renamed the constraint schemas so the new Availability API can use the unprefixed names. No request or response changed. It only affects you if you generate a typed client from the OpenAPI description, whose type names change on your next regeneration.
Orders API
- Added
providerto a refund, mirroring theprovideron a transaction. A refund now says where the money went without being read against the transaction it was taken from. - Values are
UNDERSTORY_PAY,STRIPE,PAYPAL,QUICKPAY,GIFTCARD,PUNCHCARD,SETTLEMENTandUNKNOWN. There is noEXTERNAL; a payment Understory never held cannot be given back through it. - Added
PUNCHCARDto the transaction provider. A punch card redemption is its own payment method rather than a gift card, and now says so on the paying side as well as on a refund.
Accounting API
The Accounting API has moved from Preview to Alpha. It is now available in production and can be integrated against.
- List journal entries, Get journal entry, and Record journal entry activity now carry the
Alphalabel instead ofPreview. - The specification is unchanged; no endpoints, fields, or behaviour differ from what the preview described. See API Versioning for what each label means.
Orders API
When a booking is refunded as a gift card, the gift card gets its own order. Neither end of that said so: a refund paid out as a gift card read identically to one returned to the guest's card, and the new order's transaction left you parsing an identifier to find where the money came from. Both now say it.
- Added the
SETTLEMENTtransaction provider. It means a refund on another order was used to fund this order. - Added
SettlementTransactionDetailsto thedetailsof a transaction, carryingorigin_order_id. It names the order that was refunded, so you can trace a gift card back to the booking it replaced. - Added
detailsto a refund, mirroring thedetailsalready on a transaction. A refund with nodetailswas returned to the payment method it was taken from. - Added
SettlementRefundDetails, carryingdestination_order_id. It names the order created to carry the gift card, which is where you read the card itself from.
Accounting API
- Added the optional
detail_codefield to an activity, on both Record journal entry activity and the activities returned with a journal entry. It classifies a failed sync so you can act on it without parsingdetail, and so it can be shown in the reader's own language. detailis unchanged and still carries what the accounting provider itself said about the posting — their wording, written for an accountant.detail_codesays what kind of failure it was; prefer it, and fall back todetailwhen it is absent.- The field is omitted when the integration has nothing to classify: a successful sync, or an activity recorded before the field existed. Existing activities are unaffected.
- Values are
CONFIGURATION_INCOMPLETE,CONFIGURATION_INVALID,CONNECTION_REJECTED,ACCESS_DENIED,SALES_DOCUMENT_MISSING,FINANCIAL_YEAR_MISSING,PROVIDER_REJECTEDandUNKNOWN. The set grows over time; treat an unrecognised value asUNKNOWN.
Accounting API
Documented whether a posting amount includes VAT. This is a clarification of behaviour that has always been in place — no field changed and no response is different — but the spec never stated it, and it is not what a vat_rate on every posting suggests.
- A posting's
amountis gross (VAT-inclusive) onSALEandREFUNDentries, and net (VAT-exclusive) onREVENUE_RECOGNITIONandREVENUE_RECOGNITION_REVERSALentries.BREAKAGEandADJUSTMENTentries carry no VAT. - Both gross and net postings state a
vat_rate. On a net posting the rate identifies which per-rate revenue account the amount belongs to and what VAT that revenue attracts; it is not embedded in the amount. - Which of the two applies is decided by the entry's
kind, not by the postingtype.BOOKING_PREPAYMENTis gross on aSALEand net on aREVENUE_RECOGNITION, so a rule keyed on posting type cannot express it. - If you extract VAT from every posting that carries a rate, your recognition entries are being stripped twice. That understates recognised revenue and under-draws the prepayment by the embedded VAT, and the shortfall accumulates. The VAT account still nets to zero within the entry, so a VAT return will not surface it.
- Each entry variant now states gross or net in its own description, alongside the rules on
amountandvat_rate.
Bookings API
- Added the
statusquery parameter to Get bookings. PassACTIVE,CANCELLED,MOVED, orCHECKED_INto return only bookings with that status, or comma-separate several to match any of them:status=MOVED,CANCELLED. PROCESSINGandUNKNOWNcannot be filtered on. The first is a transient checkout state and the second a defensive default, so neither is a stable thing to select by. Both still appear on returned bookings.
Accounting API
- Added the
BOOKING_FEE_REVENUEposting type. It carries the booking fee a host charges the guest on top of the ticket, and appears onSALEandREFUNDjournal entries for orders where that fee is passed on. - The fee is earned when the booking is made rather than when the experience is delivered, so it is booked as revenue at capture and never appears on
BOOKING_PREPAYMENT. It is not released again by a laterREVENUE_RECOGNITIONentry. BOOKING_FEE_REVENUEis a booking posting: it carries thebookingobject withexperience_idandlocation_ids, alongsideBOOKING_PREPAYMENTandBOOKING_REVENUE.- The
amountis VAT-inclusive andvat_ratestates the fee's own rate, which need not match the rate on any ticket in the order.
Orders API
An order's customer may now omit their address. The Orders API is read-only, so nothing you send changes.
- Updated
addresson an order's customer to be optional. It is omitted when the order has no address, where previously it was always present and filled with empty strings. - Updated
address_linesto allow an empty list, for an address recorded without a street address. A generated client that validated the previous minimum of one entry could not decode such an order at all. - If you read the address from Get orders or Get order, handle its absence. Clients that assumed the field was always present need updating, even though nothing was renamed or removed.
Bookings API
A returned booking may now omit the customer's address. Only responses changed — creating a booking works exactly as before.
- Updated
addresson a returned booking's customer to be optional. It is omitted when the booking has no address, where previously it was always present and filled with empty strings. - Updated
address_linesto allow an empty list on a returned booking, for an address recorded without a street address. A generated client that validated the previous minimum of one entry could not decode such a booking at all. POST /v1/bookingsis unchanged. It still requiresaddresswith at least one entry inaddress_lines, so no request that worked before will start failing.- If you read the address from Get booking or Get bookings, handle its absence. Clients that assumed the field was always present need updating, even though nothing was renamed or removed.
Location API
New read-only API for resolving the location_id that every event session already carries.
- Added Get Locations (
GET /v1/locations) to list the locations a company runs its experiences from, paginated with thecursorandlimitquery parameters. - Added Get Location (
GET /v1/locations/{locationId}) to retrieve a single location by thelocation_idreturned on a session. - A
Locationcarriesid,timezone,address,coordinates,created_at, andupdated_at. Locations are read-only through this API; they are created and maintained by the company inside Understory. - No company-authored label is exposed. A location's name in Understory is internal to the company's own staff, so compose your own display string from the parts in
address. - Documented that
timezoneis the authority for interpreting a session'sstart_timeandend_time, which are returned without a UTC offset, and that it falls back toEurope/Copenhagenwhen the company has not set one. coordinatesis omitted unless both a latitude and a longitude are known for the location.- A location that has been removed in Understory returns
404, so alocation_idread from an older event or booking may stop resolving. - Added the
location.readscope, required by both endpoints. Existing credentials do not gain it automatically — update or re-issue your credentials to request it.
Gift Card API
The Gift Card API is no longer read-only.
- Added
POST /v1/gift-cards/{giftCardId}/extend-expiryto push an active gift card's expiry date further out. The endpoint returns the updated gift card. It changes only the expiry date; a gift card's balance cannot be changed through this API. - The new expiry must be later than the gift card's current expiry — this action extends the expiry date and never brings it forward. An earlier or past date returns
400. - Only gift cards with status
ACTIVEcan be extended.EXPIRED,SPENT, andVOIDEDgift cards return409. - Re-sending a gift card's current expiry date has no effect and returns the gift card unchanged, so a retried request is safe.
- Added the
gift-card.writescope, required by this endpoint. Existing credentials do not gain it automatically — update or re-issue your credentials to request it.
Checkout deep linking guide
Added a new Checkout deep linking guide documenting how to link visitors directly into a Storefront's checkout flow from emails, websites, and third-party listings.
- Documented the checkout entry URL,
https://{storefront}.understory.io/checkout/{experienceId}, which works identically on storefronts served from a custom domain. - Documented the stable, public deep link parameters:
eventId,from,variant/{variantId}, andaddon/{addOnId}, including validation behavior where invalid values are silently discarded. - Documented common patterns for linking to a specific event, a specific date, or straight to the booking & payment step, and how to build links from ids returned by the Events, Experiences, and Get ticket variants endpoints.
These changes affect documentation only; no API behavior, schemas, or field names changed.
Accounting API
New APIs for consuming and reporting on journal entries in preview. This allows you to build custom accounting integrations and report back syncronization status and other relevant information to show inside Understory.
Journal entries expose the postings, references, and supporting documents needed to sync financial events into external accounting and bookkeeping systems.
- Added
GET /v1/accounting-journal-entries/{journalEntryId}to retrieve a journal entry by ID. - Added
POST /v1/accounting-journal-entries/{journalEntryId}/activitiesso integrations can relay how an entry was processed in an external accounting system eg. sync started, succeeded, or failed. - Added
v1.journal_entry.createdwebhook event for discovery. - Added
v1.journal_entry.document_attachedwebhook event, sent when a supporting document (such as a customer receipt or credit note) is attached to an existing journal entry.
Events API & Event Availability API
- Increased the maximum number of sessions per event from 10 to 50. The
sessionsarray onEventnow accepts up to 50 items. - Changed the
from/tofilters on Get events and List Event Availability to match against every session of an event instead of only the first. An event is now returned when any of its sessions starts within the requested window, so multi-session events remain in results while later sessions are still upcoming. - Documented the ordering of
GET /v1/events: results are ordered by session start time, and a multi-session event appears once, positioned by its earliest session in the requested window.
Experiences API
- Breaking change: removed the
typefield fromExperience, which previously indicated the booking model (SINGLE_SESSIONorMULTI_SESSION). The Experiences API is in Alpha and not subject to the Breaking Changes policy.
Pagination guide rewritten
The Pagination guide has been rewritten to document the consistency model of listing endpoints and how to integrate against it.
- Clarified that listing endpoints such as
GET /v1/eventsandGET /v1/bookingsare designed for ad-hoc reads, not as a continuous synchronization mechanism. - Documented that paginated responses are best-effort traversals rather than snapshots: identical requests can return different totals, and
nextdoes not guarantee consistency across pages. - Documented that cursors are opaque and short-lived, and must not be persisted across jobs, sessions, queues, or workflow state.
- Pointed at webhooks as the right mechanism for keeping a local data store in sync.
These changes affect documentation only; no API behavior, schemas, or field names changed.
Documentation improvements across all APIs
API reference documentation has been enriched across the Bookings, Events, Event Availability, Experiences, Gift Card, Marketing, Orders, and Webhooks APIs. Endpoint behavior, request and response semantics, and the full list of enum values are now described in line with each property.
- Added or expanded
infoand tag descriptions to clarify what each API is for and how it relates to the others. - Documented the meaning of every value in lifecycle and status enums, including
Booking.status,Event.state,Event.visibility,Experience.state,Experience.type,GiftCard.status,Order.status,TransactionStatus,TransactionProvider,RefundStatus,Ticket.status, ticket check-inmethod, line itemproduct_type, information requestscope, and webhook subscriptionstate. - Clarified the semantics of
from/tofilters onGET /v1/events(matched against the first session's local start time) and the local-time-without-offset representation used bySession.start_time/end_time. - Documented the snapshot semantics and per-constraint behavior of the Event Availability response, including the
EventStateConstraint,EventSeatsLimitConstraint,BookingLimitConstraint,BookingCutoffTimeConstraint, andTicketLimitConstraintshapes. - Standardized pagination, error, and 4xx response documentation across all specs.
These changes affect documentation only; no API behavior, schemas, or field names changed.
Bookings API
- Added
event_idquery parameter toGET /v1/bookingsto filter bookings for a specific event.
Bookings API
- Added
GET /v1/bookings/{bookingId}/information-request-answersendpoint to retrieve answers to information requests for a booking.
Bookings API
- Added
EXTERNALcheck-in method to ticket check-in enum. This indicates a ticket was checked in via an external system integrated with the backoffice.
Marketing API
- Added
GET /v1/marketing-consents/{id}endpoint to fetch a single marketing consent by ID. Useful for fetching consent details after receiving a webhook event. See Get marketing consent by ID for details.
Marketing API
- Added
referencesarray to marketing consents response model. References are typed links to related entities (storefronts, bookings, orders) that can be used to fetch additional details. See Get marketing consents for details.
Gift Card API
- Added new Gift Card API with endpoints to list and retrieve gift cards. See Get gift cards and Get gift card for details.
- Added
gift-card.readOAuth scope for accessing gift card data.
Marketing API
- Added webhook for new marketing consents. See Marketing consent created for details.
- Added
idto marketing consents response model as a stable reference for delta loading on the Get marketing consents endpoint.
Events API
- Added
experience_idquery parameter toGET /v1/eventsto filter events for a specific experience.
Orders API
- Added
EXTERNALtransaction provider to order transactions.EXTERNALindicates payment for an order was received in another system and marked as paid within Understory.
Events API
- Fixed
start_timeandend_timein Session to correctly return local time strings without timezone offset. The timezone is provided separately in thetimezonefield.
Bookings API & Experiences API
- Updated
localefield description to include examples and improve clarity
Third-Party Integrations (Public Beta)
Third-party integrations are now available in public beta, enabling external applications to integrate with the Understory API on behalf of Understory customers.
This feature allows developers to build applications such as:
- Marketplaces
- Marketing tools
- Accounting systems
Key capabilities:
- OAuth 2.0 Authorization Code Grant flow for secure delegated authorization
- Access and refresh token management
- Scoped permissions to request only the access your application needs
To get started, contact integrations@understory.io with your application details to receive OAuth 2.0 client credentials.
Read the full guide at Third-Party Integrations.
Event API & Event Availability API
- Changed
fromandtofilter parameters to accept local date-time without timezone (e.g.,2025-01-15T09:00:00instead of2025-01-15T09:00:00Z). The filter is matched against the event's local start time.
Webhooks API promoted to Alpha
The Webhooks API has been promoted from Preview to Alpha status. This means the API is now available for integration, though changes may still occur. See API Versioning for details.
Webhooks API (Preview)
- Added
BaseEventschema that defines the common envelope structure (id,type,timestamp,payload) for all webhook events
Webhooks API (Preview)
The Webhooks API is now available in preview.
As a preview API, this is currently a draft and is subject to change without notice.
This API enables you to:
- Create and manage webhook subscriptions to receive real-time notifications
- Subscribe to events for experiences, events, and bookings
Key features:
- Webhook subscription management (create, list, get, update, delete)
- Signature verification using HMAC-SHA256 for secure webhook delivery
- Secret key returned on subscription creation for signature verification
Available webhook events:
- Experience:
v1.experience.created,v1.experience.updated,v1.experience.deleted - Event:
v1.event.created,v1.event.updated,v1.event.cancelled,v1.event.completed,v1.event.deleted - Booking:
v1.booking.created,v1.booking.updated,v1.booking.cancelled
The specification can be inspected in API Reference: Webhook.
Experiences API
- Restructured
InformationRequestmodel to support multiple input types via discriminator pattern - Added
TextInformationRequestschema for free-form text input fields - Renamed
labeltoquestionfor clarity on what is presented to the guest - Promoted
Get information requestsandGet ticket variantsendpoints to Alpha
Event Availability API
- Renamed
remainingtocutoff_timeinBookingCutoffConstraintfor clarity
Other improvements
- Added default error responses to information requests and ticket variants endpoints
- Fixed
Accept-Languageheader handling in Experiences API
Events and Experiences APIs promoted to Alpha
The Events and Experiences APIs have been promoted from Preview to Alpha status. This means they are now available for integration, though changes may still occur. See API Versioning for details.
Additional improvements in this release:
- Added
UNKNOWNto state and visibility enums for better forward compatibility - Added
INACTIVEstate to the Experiences API - Improved error responses with proper 403 and 404 status codes
- Updated Metadata schema to use
additionalPropertieswith string values
Event Availability API updates
- Renamed
SeatsLimitConstrainttoEventSeatsLimitConstraint(type:EVENT_SEATS_LIMIT) - Added new
EventStateConstraint(type:EVENT_STATE) for event state-based availability
Pagination improvements across APIs
Pagination parameters have been standardized across the Bookings, Grow, Events, and Experiences APIs:
- Added explicit
minimum: 1andmaximum: 100constraints to limit parameters - Improved documentation for cursor and limit parameters
The Event Availability API is now available in alpha. This API allows querying availability for events, including remaining capacity and constraint information such as seat limits, booking limits, ticket limits, and booking cutoff times.
The specification can be inspected in API Reference: Event Availability.
The Experiences API has been updated. Specifically, the media property in the image variant no longer has a preview_url field.
The Experiences and Events preview APIs have been updated. This change includes a lot of changes to the general models while preserving the available data.
- Experiences are no longer differentiated by being shared or not. All experiences should be considered the same.
- Events now include sessions which contains the specific date and time for when the event is held. This moves a lot of fields from experiences into sessions for better separation and composability.
- Computed fields have been removed from events' capacity. These can be calculated client side if needed based on
totalandreservedfields on the Capacity model.
The Bookings API is moved to Alpha. This means the API is available for integration but changes might still occur. Read the API Versioning article for more details.
POST /v1/bookings: A new optional request body fieldmetadatais added to allow for custom key/value pairs of metadata to be attached on the booking for later reference.POST /v1/bookings: The endpoint now only returns the ID and status of a successfull booking operation.
The Events API is now available in early preview. The specification can be inspected in API Reference: Event.
The Experience API is now available in early preview. The specification can be inspected in API Reference: Experience.
The Bookings API is now available in early preview. The specification can be inspected in API Reference: Booking.
This release adds marketing consents to the API enabling marketing automation flows.
Read more about the API in the API Reference: Get marketing consents.