Skip to main content
GET
List room types
Draft: This endpoint is still in progress. Its parameters and response shape may change before it is finalized.

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, all locale keys are returned. 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. See Pagination.

Maximum string length: 2000
hotelId
string

Filter by hotel id.

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

Filter by number of beds.

Required range: 1 <= x <= 10
code
string

Filter by exact room type code.

Maximum string length: 200

Full-text search of the localized category name across all supported languages (case- and diacritics-insensitive). To match a code, use code.

Maximum string length: 200
expand
enum<string>

Set to hotel to embed the hotel in each room type.

Available options:
hotel
sort
enum<string>
default:createdAt:desc

Sort order by creation time: createdAt:desc returns the newest records first, createdAt:asc the oldest. Records are ordered by their id, which increases with creation time, giving a stable total order that keeps cursor pagination exact.

Available options:
createdAt:desc,
createdAt:asc

Response

A paginated list of room types.

data
object[]
required
pagination
object
required