Skip to main content
Use API v2 for the resources available in its reference. See API coverage for the released resources.

​
Version path

The API version is explicit in the URL path:

​
Changes to API v2

API v2 is still in development. Its contracts can change in ways that are not backward compatible, for example renamed fields or changed query parameters. Such changes keep the /api/v2 path. The documentation always describes the current behavior. New fields, query parameters, endpoints, and values can be added at any time. Ignore response fields that you do not use, so that additions do not break your client.

​
Catalog codes

Procedure codes and categories, natural-source codes, collections and unavailability reasons can gain values. Treat these response codes as extensible strings when generating client types. Use a procedure’s returned label even when its code or category is new. Omit an unrecognized natural-source badge or collection grouping. For an unknown unavailability reason, show a general unavailable state and respect available: false. This rule does not apply to control values such as category, payer, bookingMode, arrival.type or stayLength.unit. Their documented values define the contract’s behavior.