Skip to content
Booking Engine API Docs

/v1/availability

GET
/v1/availability
curl --request GET \
  --url 'http://localhost:8787/v1/availability?resource_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&from=2026-04-15T12%3A00%3A00Z&to=2026-04-15T12%3A00%3A00Z&party_size=1' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
resource_id
required
string format: uuid
from
required
string format: date-time
to
required
string format: date-time
party_size
required
integer
> 0

Responses

Section titled “Responses”

200

Section titled “200”

Net availability for the requested resource + window.

Media typeapplication/json
object
available
required
boolean
from
required
string
partySize
required
integer
reasons
required
Array<string>
Allowed values: occupancy_exceeded reserved external_block min_stay max_stay closed_to_arrival closed_to_departure stop_sell
resourceId
required
string format: uuid
to
required
string
Example
{
  "reasons": [
    "occupancy_exceeded"
  ]
}

400

Section titled “400”

from is not strictly before to.

Media typeapplication/problem+json
object
code
required
string
Allowed values: resource_not_found no_room_type unknown_rate_plan_code invalid_window range_too_large
detail
required
string
status
required
number
title
required
string
type
required
string
Example
{
  "code": "resource_not_found"
}

404

Section titled “404”

No such resource for this tenant.

Media typeapplication/problem+json
object
code
required
string
Allowed values: resource_not_found no_room_type unknown_rate_plan_code invalid_window range_too_large
detail
required
string
status
required
number
title
required
string
type
required
string
Example
{
  "code": "resource_not_found"
}