Reservations
/reservations
Get reservations
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.
limit?number
Default
100Range
1 <= value <= 250page?number
Default
1Range
1 <= valueResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/reservations"{
"data": [
{
"currency": "string",
"uniqueRef": "string",
"guestName": "string",
"bookerName": "string",
"checkIn": "string",
"checkOut": "string",
"generalLedgerPostingAt": "string",
"bookedAt": "string",
"cancelledAt": "string",
"bookingPlatform": "string",
"confirmationCode": "string",
"pmsReferenceCode": "string",
"guests": 0,
"userdata": {
"property1": null,
"property2": null
},
"metadata": {
"property1": null,
"property2": null
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"shortRef": "string",
"generalLedgerStatus": "active",
"lock": {
"status": "locked",
"booksClosed": {
"date": "string"
},
"ownerStatement": {
"ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
},
"reconciled": {
"bankRecordIds": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
},
"statementPeriod": {
"hits": [
{
"listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
"txnAt": "string",
"openFrom": "string"
}
]
}
},
"issues": [
{
"code": "lineNotFound",
"severity": "error",
"context": {
"lineIds": [
"string"
]
},
"message": "string"
}
],
"connection": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"status": "active",
"uniqueRef": "string",
"appId": "string"
},
"nights": 0,
"status": "booked",
"listing": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"uniqueRef": "string",
"shortRef": "string"
},
"listingConnection": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"uniqueRef": "string",
"shortRef": "string"
},
"payment": {
"expected": 0,
"received": 0,
"status": "unpaid"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"status": "active",
"appId": "string",
"appIcon": "string"
},
"lines": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"uniqueRef": "string",
"type": "string",
"description": "string",
"amount": -9007199254740991,
"connectionId": "string",
"metadata": {
"property1": null,
"property2": null
},
"generalLedgerPostingAt": "string",
"account": {
"id": "string",
"name": "string",
"uniqueRef": "string",
"status": "active"
},
"isExcluded": true
}
],
"managerCentTotal": 0,
"taxCentTotal": 0,
"ownersCentTotal": 0
}
],
"pagination": {
"limit": 100,
"page": 1,
"total": 0,
"totalPage": 0,
"nextPage": 0
}
}{
"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
}