Reservations
/reservations/csv
Reservations CSV export
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Query Parameters
ids?string
Comma-separated reservation ids. Prefix with ! to exclude matching ids.
Format
vrp-csvshortRefs?string
Comma-separated reservation short refs.
Format
vrp-csvstatus?string
Value in
"booked" | "canceled" | "inactive"generalLedgerStatus?string
Value in
"active" | "inactive"listingId?string
date?string
Date filter string. Accepted syntax: YYYY, YYYY-MM, YYYY-MM-DD, or range YYYY-MM-DD...YYYY-MM-DD. Single values expand to the full year, month, or day.
Format
vrp-date-filterdateField?string
Choose which reservation date field the date filter applies to.
Value in
"bookedAt" | "checkIn" | "checkOut" | "payment" | "intersection"search?string
paidStatus?string
unpaid, underpaid, overpaid, paid, !unpaid, !underpaid, !overpaid, !paid
connectionId?string
bookingChannel?string
amount?number
businessModel?string
Value in
"managed" | "co_host" | "co_host_airbnb"lineType?string
Filter by reservation line type (paymentLine.effectiveType), only when not excluded
includeLines?boolean
When true, include nested line items in each returned reservation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/reservations/csv"{
"url": "string"
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}