/v1/bookings (GET)

GET

/v1/bookings

const url = 'http://localhost:8787/v1/bookings?state=pending';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:8787/v1/bookings?state=pending' \
  --header 'Authorization: Bearer <token>'

Authorizations

ApiKeyAuth
SessionCookie

Parameters

Query Parameters

state

string

Allowed values: pending held confirmed cancelled checked_in checked_out no_show expired

from

string format: date-time

resourceId

string format: uuid

cursor

string

limit

integer

> 0 <= 100

Responses

200

The tenant’s bookings, newest-first (created_at desc, id desc), cursor-paginated, including PII (guestEmail) — sk_ only.

application/json

object

data

required

Array<object>

object

createdAt

required

string

currency

required

string

>= 3 characters <= 3 characters

endsAt

required

string

guestEmail

required

string | null

holdExpiresAt

required

string | null

required

string format: uuid

occupancyAdults

required

integer | null

occupancyChildren

required

integer

quantity

required

integer

ratePlanId

required

string | null format: uuid

resourceId

required

string format: uuid

roomTypeId

required

string | null format: uuid

source

required

string

startsAt

required

string

state

required

string

Allowed values: pending held confirmed cancelled checked_in checked_out no_show expired

totalMinorUnits

required

string

/^\d+$/

updatedAt

required

string

nextCursor

required

string | null

Example

{
  "data": [
    {
      "state": "pending"
    }
  ]
}

400

The cursor query param is malformed, tampered, or foreign to this tenant.

application/problem+json

object

code

required

string

Allowed values: booking_not_found illegal_transition invalid_cursor

detail

required

string

status

required

number

title

required

string

type

required

string

Example

{
  "code": "booking_not_found"
}

404

Unreachable in practice (requireApiKey/requirePrincipal always run first) — declared only for the defensive !principal fallback’s type, same shape as the sibling routes below.

application/problem+json

object

code

required

string

Allowed values: booking_not_found illegal_transition invalid_cursor

detail

required

string

status

required

number

title

required

string

type

required

string

Example

{
  "code": "booking_not_found"
}