Skip to main content
GET
Get a visit type

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.

Path Parameters

visitTypeId
string
required

Visit type id.

Pattern: ^[0-9a-fA-F]{24}$

Query Parameters

expand
enum<string>[]

Comma-separated expansions. hotel adds hotelListings[].hotel; priceFromPeriods adds price periods to the package and to each listing, and also returns ended promotions. See Expand.

Available options:
hotel,
priceFromPeriods
hotelId
string

Return only this hotel's hotelListings[] entry, for example together with expand=priceFromPeriods. priceFrom, priceFromPeriods, availability, channelContent and promotions describe the whole package and do not change. The id of a hotel that does not sell the package, or that your key cannot access, returns 200 with hotelListings: [].

Pattern: ^[0-9a-fA-F]{24}$

Response

The visit type.

A stay package sold by one or more hotels. See Visit type for the field reference and Visit types for availability and stay rules.

id
string
required

Visit type id. Price minima reference the visit type by this id.

Pattern: ^[0-9a-fA-F]{24}$
name
object
required

Localized name. A missing translation falls back to the Czech name.

shortDescription
object
required

Localized plain-text teaser for package lists and previews, up to 120 characters per translation. A missing translation is null.

category
enum<string>
required

health is a spa cure with medical treatment; wellness is any other stay, such as a wellness weekend.

Available options:
health,
wellness
payer
enum<string> | null
required

Who pays for a health stay; null for wellness stays. See Payer.

Available options:
guest,
guest_and_insurer,
insurer,
null
bookingMode
enum<string>
required

instant: a booking is confirmed immediately when a room is available. request: every booking is a request that the hotel confirms. Packages with payer: insurer are always request.

Available options:
instant,
request
available
boolean
required

Whether the package is offered now. Independent of room capacity and prices on particular dates.

unavailableReason
enum<string> | null
required

Why the package is unavailable; null when it is available. See Availability.

Available options:
disabled,
ended,
no_arrival,
no_hotels,
null
webOrder
integer | null
required

Position of the package on the website, starting at 1, or null when it has none. Used by sort=webOrder.

Required range: x >= 1
channelContent
object
required

Content for the sales channel of your public key. See Channel content.

board
object
required

Meals included in the package and the changes a guest can make. See Board.

Example:
stayLength
object
required

Permitted stay length. See Stay length and arrival.

validity
object[] | null
required

Current and future validity periods, ordered by from, then to. Null when no periods are configured; empty when every configured period has ended. See Validity.

arrival
Weekday arrival · object
required

Permitted arrival days: either weekdays or explicit dates. See Stay length and arrival.

treatment
object
required

Examinations and procedures included in a package. See Treatment.

Example:
priceFrom
object | null
required

Lowest prices of a complete stay from today onward across the package's hotels, per currency. A currency is present only when a complete stay has a price in it. Packages booked on request and packages switched off in SpaPortal also have a price; check available and bookingMode before you offer a booking. Null when no complete stay exists. See Prices.

promotions
object[]
required

Current and future promotions that apply to your channel, ordered by from, then id. With expand=priceFromPeriods, also ended promotions, so every id in a period can be looked up. Empty when none applies.

hotelListings
object[]
required

Active hotels selling the package, each with the package's price at that hotel, ordered by Czech hotel name, then id. A listing is present even when its priceFrom is null.

images
object[]
required

Photos in configured order; the first is the main photo. A missing alt translation falls back to the localized package name; an empty alt marks a decorative image. See Images.

priceFromPeriods
object[] | null

Price periods of the package across all its hotels, including past periods, ordered by from. Present only on the detail with expand=priceFromPeriods. Empty when the package has no price list for the nights of its validity; null when SpaPortal cannot calculate the periods. Free rooms and permitted arrival days are not checked. See Price period.