Skip to content

Bookings

GET /partner/v1/bookings lists the agency’s bookings for reporting, channel reconciliation or occupancy dashboards. Requires scope read:bookings.

Guest personal data is never included. Rows carry dates, status, source and totals; names, contacts and documents stay inside the PMS. An integration that needs guest data talks to the agency — an API key is not a consent.

Terminal window
curl "https://api.myrentalcalendar.com/partner/v1/bookings?from=2026-09-01&to=2026-09-30&status=confirmed" \
-H "Authorization: Bearer $STAYOS_KEY"
ParameterMeaning
from / toStay overlap filter: every booking whose stay touches the range (arrival ≤ to and departure ≥ from)
statusOne of inquiry, option, confirmed, checked_in, checked_out, closed, cancelled, expired, rejected, no_show, draft
unitUnit slug
limitMax rows, 1–200 (default 100), newest arrival first
{
"bookings": [
{
"id": "0191a…",
"unitSlug": "marina-loft-2br",
"unitName": "Marina Loft · 2BR",
"type": "guest",
"status": "confirmed",
"source": "airbnb",
"arrival": "2026-09-10",
"departure": "2026-09-14",
"nights": 4,
"adults": 2,
"children": 1,
"totalAmount": 223650
}
]
}

type distinguishes revenue stays (guest) from owner_stay, maintenance and block rows — filter on it before computing occupancy or revenue. totalAmount is 0 for non-guest rows and quotes in the currency’s minor unit otherwise.