Skip to Content

AccommodationApi

All URIs are relative to https://business.apis.kesk.app/v1 

MethodHTTP requestDescription
calculatePropertyPricePOST /accommodation/properties/{id}/calculate-priceCalculate price for a booking
cancelMyBookingPOST /accommodation/my/bookings/{id}/cancelCancel booking (requires auth)
checkPropertyAvailabilityPOST /accommodation/properties/{id}/check-availabilityCheck availability for a date range
createPropertyBookingPOST /accommodation/properties/{id}/bookCreate a booking (requires auth)
createPropertyReviewPOST /accommodation/properties/{id}/reviewsSubmit property review (requires auth)
getBookingCancellationInfoGET /accommodation/my/bookings/{id}/cancellation-infoGet cancellation info/preview (requires auth)
getMyBookingGET /accommodation/my/bookings/{id}Get booking details (requires auth)
getPropertyGET /accommodation/properties/{id}Get property details by ID
getPropertyBySlugGET /accommodation/properties/slug/{slug}Get property by slug
getPropertyReviewsGET /accommodation/properties/{id}/reviewsGet property reviews
getSimilarPropertiesGET /accommodation/properties/{id}/similarGet similar properties
listAmenitiesGET /accommodation/amenitiesList amenities
listCancellationPoliciesGET /accommodation/cancellation-policiesList cancellation policies
listMyBookingsGET /accommodation/my/bookingsList user’s bookings (requires auth)
listPropertiesGET /accommodation/propertiesList properties with filters
listPropertyReportReasonsGET /accommodation/property-report-reasonsGet property report reasons
listPropertyTypesGET /accommodation/property-typesList property types
reportPropertyPOST /accommodation/properties/{id}/reportReport a property (requires auth)

calculatePropertyPrice

PriceCalculationResponse calculatePropertyPrice(id, CalculatePriceRequest)

Calculate price for a booking

Calculates the total price for a booking including nightly rates, fees, taxes, and any applicable discounts.

Parameters

NameTypeDescriptionNotes
idLongProperty ID[default to null]
CalculatePriceRequestCalculatePriceRequestPrice calculation request

Return type

PriceCalculationResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

cancelMyBooking

BookingOrderResponse cancelMyBooking(id, CancelBookingRequest)

Cancel booking (requires auth)

Cancels a booking belonging to the authenticated user. Refund amount is calculated based on the property’s cancellation policy.

Parameters

NameTypeDescriptionNotes
idLongBooking ID[default to null]
CancelBookingRequestCancelBookingRequestCancellation request

Return type

BookingOrderResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

checkPropertyAvailability

AvailabilityCheckResponse checkPropertyAvailability(id, CheckAvailabilityRequest)

Check availability for a date range

Checks if the property is available for booking during the specified dates.

Parameters

NameTypeDescriptionNotes
idLongProperty ID[default to null]
CheckAvailabilityRequestCheckAvailabilityRequestAvailability check request

Return type

AvailabilityCheckResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

createPropertyBooking

BookingOrderResponse createPropertyBooking(id, CreateBookingRequest)

Create a booking (requires auth)

Creates a new booking for a property. The booking may be instant or require host approval depending on the property settings.

Parameters

NameTypeDescriptionNotes
idLongProperty ID[default to null]
CreateBookingRequestCreateBookingRequestBooking request details

Return type

BookingOrderResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

createPropertyReview

PropertyReviewResponse createPropertyReview(id, CreatePropertyReviewRequest)

Submit property review (requires auth)

Submits a review for a property. The user must have a completed booking for the property to submit a review.

Parameters

NameTypeDescriptionNotes
idLongProperty ID[default to null]
CreatePropertyReviewRequestCreatePropertyReviewRequestReview details

Return type

PropertyReviewResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

getBookingCancellationInfo

CancellationInfoResponse getBookingCancellationInfo(id)

Get cancellation info/preview (requires auth)

Retrieves cancellation information including the calculated refund amount before actually cancelling a booking.

Parameters

NameTypeDescriptionNotes
idLongBooking ID[default to null]

Return type

CancellationInfoResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getMyBooking

BookingOrderResponse getMyBooking(id)

Get booking details (requires auth)

Retrieves detailed information about a specific booking belonging to the authenticated user.

Parameters

NameTypeDescriptionNotes
idLongBooking ID[default to null]

Return type

BookingOrderResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getProperty

PropertyResponse getProperty(id)

Get property details by ID

Retrieves complete details for a specific property including amenities, pricing, location, and availability information.

Parameters

NameTypeDescriptionNotes
idLongProperty ID[default to null]

Return type

PropertyResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getPropertyBySlug

PropertyResponse getPropertyBySlug(slug)

Get property by slug

Retrieves property details using the URL-friendly slug identifier.

Parameters

NameTypeDescriptionNotes
slugStringProperty slug[default to null]

Return type

PropertyResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getPropertyReviews

PaginatedResponse_PropertyReviewResponse getPropertyReviews(id, page, per_page)

Get property reviews

Retrieves a paginated list of reviews for a specific property.

Parameters

NameTypeDescriptionNotes
idLongProperty ID[default to null]
pageLongPage number (default: 1)[optional] [default to null]
per_pageLongItems per page (default: 10)[optional] [default to null]

Return type

PaginatedResponse_PropertyReviewResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getSimilarProperties

List getSimilarProperties(id, limit)

Get similar properties

Retrieves properties similar to the specified property based on location, type, and price range.

Parameters

NameTypeDescriptionNotes
idLongProperty ID[default to null]
limitLongMaximum number of results (default: 6)[optional] [default to null]

Return type

List

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listAmenities

List listAmenities()

List amenities

Retrieves all available amenities that properties can have.

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listCancellationPolicies

List listCancellationPolicies()

List cancellation policies

Retrieves all available cancellation policies with their refund rules.

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listMyBookings

PaginatedResponse_BookingOrderResponse listMyBookings(status, page, per_page)

List user’s bookings (requires auth)

Retrieves a paginated list of the authenticated user’s bookings.

Parameters

NameTypeDescriptionNotes
statusStringFilter by status: upcoming, current, past, cancelled[optional] [default to null]
pageLongPage number (default: 1)[optional] [default to null]
per_pageLongItems per page (default: 20)[optional] [default to null]

Return type

PaginatedResponse_BookingOrderResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listProperties

PaginatedResponse_PropertyListResponse listProperties(latitude, longitude, radius_km, property_type_ids, amenity_ids, min_price, max_price, min_guests, check_in_date, check_out_date, min_bedrooms, min_bathrooms, instant_booking_only, page, per_page, sort_by, sort_order)

List properties with filters

Retrieves a paginated list of properties matching the specified filters. Supports filtering by location, price range, amenities, and availability.

Parameters

NameTypeDescriptionNotes
latitudeDoubleLatitude coordinate for geo-filtering[optional] [default to null]
longitudeDoubleLongitude coordinate for geo-filtering[optional] [default to null]
radius_kmDoubleSearch radius in kilometers[optional] [default to null]
property_type_idsStringComma-separated property type IDs[optional] [default to null]
amenity_idsStringComma-separated amenity IDs[optional] [default to null]
min_priceDoubleMinimum price per night[optional] [default to null]
max_priceDoubleMaximum price per night[optional] [default to null]
min_guestsIntegerMinimum number of guests[optional] [default to null]
check_in_dateStringCheck-in date (YYYY-MM-DD format)[optional] [default to null]
check_out_dateStringCheck-out date (YYYY-MM-DD format)[optional] [default to null]
min_bedroomsIntegerMinimum number of bedrooms[optional] [default to null]
min_bathroomsIntegerMinimum number of bathrooms[optional] [default to null]
instant_booking_onlyBooleanOnly show properties with instant booking enabled[optional] [default to null]
pageLongPage number (default: 1)[optional] [default to null]
per_pageLongItems per page (default: 20, max: 100)[optional] [default to null]
sort_byStringSort field: price, rating, distance, created_at, name[optional] [default to null]
sort_orderStringSort order: asc, desc[optional] [default to null]

Return type

PaginatedResponse_PropertyListResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listPropertyReportReasons

List listPropertyReportReasons()

Get property report reasons

Retrieves all available reasons for reporting a property.

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listPropertyTypes

List listPropertyTypes()

List property types

Retrieves all available property types (e.g., Apartment, House, Villa).

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

reportProperty

PropertyReportResponse reportProperty(id, CreatePropertyReportRequest)

Report a property (requires auth)

Reports a property for violating platform guidelines.

Parameters

NameTypeDescriptionNotes
idLongProperty ID[default to null]
CreatePropertyReportRequestCreatePropertyReportRequestReport details

Return type

PropertyReportResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8