Skip to content
Booking Engine API Docs

/v1/resources/{id}/calendar

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
from
required
string format: date-time
to
required
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Per-day availability/price-hint/restrictions for the requested window. Strong ETag + Cache-Control: max-age=60.

Media typeapplication/json
object
currency
required
string
>= 3 characters <= 3 characters
days
required
Array<object>
object
date
required
string
priceHintMinorUnits
required
string | null
/^\d+$/
reasons
required
Array<string>
Allowed values: occupancy_exceeded reserved external_block min_stay max_stay closed_to_arrival closed_to_departure stop_sell
restrictions
required
object
closedToArrival
required
boolean
closedToDeparture
required
boolean
maxStayNights
required
integer | null
minStayNights
required
integer | null
stopSell
required
boolean
status
required
string
Allowed values: available unavailable
from
required
string
resourceId
required
string format: uuid
to
required
string
Example
{
  "days": [
    {
      "reasons": [
        "occupancy_exceeded"
      ],
      "status": "available"
    }
  ]
}

Headers

Section titled “Headers”
ETag
string

Strong ETag

304

Section titled “304”

If-None-Match matched the current ETag — body unchanged, re-use your copy.

400

Section titled “400”

from is not strictly before to, or the range exceeds 366 nights.

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"
}