Skip to main content
GET
List visit types

Authorizations

X-SpaPortal-Public-Key
string
header
required

See Authentication for how to obtain and send your public key.

Headers

Accept-Language
string

Comma-separated BCP 47 language tags selecting which locale keys localized fields return. When omitted or *, all locale keys are returned. Inside a list, * adds the locales you do not list, at its own quality value. See Localization for details.

Example:

"cs-CZ,de"

X-Request-Id
string

Optional client-provided request identifier echoed in error responses.

Query Parameters

limit
integer
default:25

Number of records to return. See Pagination.

Required range: 1 <= x <= 100
cursor
string

Cursor from the previous page's pagination.nextCursor. Keep the sort and filters unchanged while paging.

Maximum string length: 2000
sort
enum<string>
default:webOrder

webOrder follows the website position across all companies of your public key: packages with a position first, in position order, then the others in a stable order. createdAt:desc and createdAt:asc order by record id, which generally follows creation order. Cursors do not freeze a snapshot: changes between requests, including the change of day at midnight (Europe/Prague), can skip or repeat a package.

Available options:
webOrder,
createdAt:desc,
createdAt:asc
available
enum<string>
default:true

Filter by catalog availability. See Availability.

Available options:
true,
false,
all

Substring of the package name in any language, case- and diacritics-insensitive.

Maximum string length: 200
hotelId
string

Return only packages sold by this hotel. An unknown or unauthorized id matches no packages. The filter does not narrow hotelListings[] or the package's priceFrom; read the price at this hotel from its hotelListings[] entry.

Pattern: ^[0-9a-fA-F]{24}$
category
enum<string>[]

Match any of the listed categories.

Available options:
health,
wellness
payer
enum<string>[]

Match any of the listed payers. Wellness packages have payer: null and never match.

Available options:
guest,
guest_and_insurer,
insurer
collection
enum<string>[]

Match any of the listed codes in channelContent.collections. Outside the company's own website channel no package matches. See Channel content.

Website collection code. See Channel content for the meaning of each code.

Available options:
advent_christmas_new_year,
families_with_children,
wellness,
treatment_stays,
special_offers,
hotel_stay
bookingMode
enum<string>

Match the booking mode.

Available options:
instant,
request
procedure
enum<string>[]

Match packages whose treatment.procedures.items contain all listed codes. Packages with selection: hotel_offer never match.

Procedure code. See Procedure codes.

Available options:
bubble_bath,
carbon_dioxide_bath,
bubble_bath_with_additives,
kneipp_water_treading,
hydroxeur,
herbal_bath,
whirlpool_foot_bath,
radon_bath,
peat_bath,
peat_wrap,
paraffin_wrap,
peat_vaginal_tampons,
diadynamic_therapy,
magnetic_therapy,
ultrasound,
co2_gas_injections,
dry_carbon_dioxide_bath,
molecular_hydrogen_therapy,
classic_full_body_massage,
partial_massage,
fitness_centre_exercise,
individual_physiotherapy,
cardiotherapy,
machine_lymphatic_drainage,
manual_lymphatic_drainage,
reflex_massage,
hot_stone_massage,
anti_cellulite_massage,
aroma_massage,
french_ear_acupuncture,
classic_chinese_acupuncture,
inhalation,
oxygen_therapy,
cryotherapy,
thai_aroma_oil_massage,
thai_foot_massage,
thai_warm_oil_massage,
classic_thai_massage,
thai_coconut_dream,
thai_head_and_back_massage,
thai_herbal_massage,
thai_special_back_massage,
thai_pregnancy_massage,
vaginal_irrigation,
drinking_cure,
ecg,
inbody_diagnostics,
vascular_condition_measurement
board
enum<string>[]

Match packages whose included meals contain all listed codes. A meal that is only changeable does not match.

Meal code. See Board.

Available options:
breakfast,
lunch,
dinner,
all_inclusive
nights
integer

Match packages that permit a stay of this many nights. A week is seven nights and week-based packages require whole weeks. See Stay rules.

Required range: 1 <= x <= 693
arrivalFrom
string<date>

Start of an inclusive arrival window; requires arrivalTo, at most 366 days later. Matches packages with a permitted stay that arrives in the window, from today onward, of nights nights or of their shortest permitted length. Prices and room capacity are not checked.

arrivalTo
string<date>

End of the arrival window, inclusive. A missing arrivalFrom, a reversed window or a window longer than 366 days returns 400.

expand
enum<string>[]

hotel adds hotelListings[].hotel. priceFromPeriods is accepted only by the detail endpoint and returns 400 here. See Expand.

Available options:
hotel

Response

A page of visit types.

data
object[]
required

Visit types on this page.

pagination
object
required

Cursor of the next page and the total number of matching visit types.