Skip to content
Booking Engine API Docs

/v1/resources/{id}

GET
/v1/resources/{id}
curl --request GET \
  --url http://localhost:8787/v1/resources/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”

One resource + its room-type + rate-plan shape.

Media typeapplication/json
object
capacity
required
integer
currency
required
string
>= 3 characters <= 3 characters
id
required
string format: uuid
kind
required
string
name
required
string
photoUrls
required
Array<string>
ratePlans
required
Array<object>
object
closedToArrival
required
boolean
closedToDeparture
required
boolean
code
required
string
currency
required
string
>= 3 characters <= 3 characters
enabled
required
boolean
id
required
string format: uuid
isRefundable
required
boolean
maxStayNights
required
integer | null
minStayNights
required
integer
name
required
string
roomType
required
object
code
required
string
id
required
string format: uuid
maxAdults
required
integer
maxChildren
required
integer
maxOccupancy
required
integer
name
required
string
slug
required
string
Examplegenerated
{
  "capacity": 1,
  "currency": "example",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "kind": "example",
  "name": "example",
  "photoUrls": [
    "example"
  ],
  "ratePlans": [
    {
      "closedToArrival": true,
      "closedToDeparture": true,
      "code": "example",
      "currency": "example",
      "enabled": true,
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "isRefundable": true,
      "maxStayNights": 1,
      "minStayNights": 1,
      "name": "example"
    }
  ],
  "roomType": {
    "code": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "maxAdults": 1,
    "maxChildren": 1,
    "maxOccupancy": 1,
    "name": "example"
  },
  "slug": "example"
}

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