Get Bookings
GET
/api/v1/external-app/get-bookings
Last modified:2026-05-03 12:30:12
Query Parameters
Pagination
| Parameter | Type | Default | Description |
|---|---|---|---|
page | number | 0 | Page number (zero-indexed) |
per_page | number | 50 | Number of results per page (max: 10000) |
Filtering
q parameter. Multiple filters can be combined using $$ as a separator.q=<filterKey><operator><value>q=<filter1>$$<filter2>$$<filter3>Available Filter Keys
| Filter Key | Type | Description |
|---|---|---|
searchText | string | Search across booking id, resident name, email, phone, and channel name |
id | number | Filter by exact booking ID |
propertyId | number | Filter bookings by property |
channelId | number | Filter bookings by channel |
userId | number | Filter bookings by the resident/POC user ID |
roomId | number | Filter bookings that have an occupancy in a specific room |
sessionId | number | Filter by session ID |
source | string | Filter by booking source (e.g. Website) |
status | enum | Filter by internal booking status (see values below) |
displayStatus | enum | Filter by display status shown to users (see values below) |
isPocResident | boolean | Filter by whether the POC is also the resident (true or false) |
isRebooked | boolean | Filter bookings that are a rebook of a previous booking (true or false) |
startDateTime | datetime | Filter by move-in date |
endDateTime | datetime | Filter by move-out date |
createdAt | datetime | Filter by booking creation date |
updatedAt | datetime | Filter by last updated date |
status Enum Values
| Value | Description |
|---|---|
Draft | Booking is being created but is missing required details |
Pending | Booking created; awaiting completion or payment |
Confirmed | Booking confirmed; room locked in for check-in |
Cancelled | Booking was abandoned or cancelled before check-in |
Closed | All settled; booking is closed |
displayStatus Enum Values
| Value | Description |
|---|---|
Draft | Booking has just been initiated |
Pending | Reservation has been made |
Reserved | Reservation payment has been received |
Check-In Ready | Check-in payment received and all beds assigned |
Confirmed | All check-ins completed |
Under Notice | Booking is under notice period for closure |
Rebooked | Booking was rebooked from a previously closed booking |
Ending Soon | Booking is nearing its end date |
Term Ended | End date has passed but residents have not yet checked out |
Cancelled | Booking has been cancelled |
Closed | Booking is fully closed |
Refund Pending | Booking is closed but a refund is still pending |
Operators
| Operator | Meaning |
|---|---|
:= | Exact match |
~= | Contains (partial match) |
>= | Greater than or equal |
<= | Less than or equal |
!= | Not equal |
Filter Examples
# Get all pending bookings for a property
GET /api/v1/external-app/get-bookings?q=propertyId:=412$$status:=Pending
# Search by resident phone number
GET /api/v1/external-app/get-bookings?q=searchText~=+9198801
# Get bookings starting after a specific date
GET /api/v1/external-app/get-bookings?q=startDateTime>=2026-07-01
# Get all rebooked bookings
GET /api/v1/external-app/get-bookings?q=isRebooked:=trueSorting
| Parameter | Type | Options | Default |
|---|---|---|---|
sort | string | createdAt, updatedAt, startDateTime, endDateTime | createdAt |
order | string | asc, desc | desc |
Authentication
Authorization header. Obtain one via the Credential Refresh endpoint.Request
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://server.wardenera.com/api/v1/external-app/get-bookings' \
--header 'User-Agent: insomnia/11.4.0' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"bookings": [
{
"id": 15902,
"status": "Pending",
"residentType": "Unknown",
"source": "Website",
"fileName": null,
"companyId": 11,
"propertyId": 412,
"userId": 31973,
"channelId": 32,
"salesPersonPermissionId": 8091,
"startDateTime": "2026-07-18T00:00:00+05:30",
"extensionStartDateTime": null,
"endDateTime": "2026-09-18T23:59:59+05:30",
"occupantCount": {
"adults": 1,
"beds": 1
},
"onboardingData": {
"isContractSigned": false
},
"offboardingData": {},
"data": null,
"legal": null,
"extensionHistory": [],
"autoDiscardDateTime": "2026-07-21T00:00:00+05:30",
"autoDiscardData": {
"isManuallyUpdated": false,
"stage": "Check-In Payment Pending",
"isActive": true,
"reason": "Auto-discard set for stage Check-In Payment Pending via Channel Warden Booking Engine (ID: 32) with 259200s (72h 0m) expiry",
"expiryTimeLabel": "3 days"
},
"planMetaId": 14678,
"isDeleted": false,
"createdAt": "2026-05-03T13:50:41+05:30",
"updatedAt": "2026-05-03T13:50:55+05:30",
"createdById": 8091,
"updatedById": 8091,
"originalTimezone": "Asia/Kolkata",
"isClosing": false,
"rebookedFromId": null,
"sessionId": null,
"externalId": null,
"externalData": null,
"externalRawData": null,
"bookingWorkflowConfig": null,
"endingAlertDateTime": "2026-08-06T00:00:00+05:30",
"isEndingSoon": false,
"displayStatus": "Pending",
"channelName": "Warden Booking Engine",
"propertyName": "Warden House Koramangala",
"session": null,
"occupancies": [
{
"id": 131454,
"companyId": 11,
"startDateTime": "2026-07-18T00:00:00+05:30",
"endDateTime": "2026-09-18T23:59:59+05:30",
"status": "Assigned",
"bedId": 22741,
"roomId": 13327,
"roomTypeId": 1385,
"propertyId": 412,
"roomTypeRateId": 1419,
"note": null,
"bookingId": 15902,
"residentId": null,
"leadId": null,
"parentOccupancyId": null,
"originalTimezone": "Asia/Kolkata",
"fragmentedChildOccupancyId": null,
"checkedInAt": null,
"checkedOutAt": null,
"isDeleted": false,
"isAbandoned": false,
"createdAt": "2026-05-03T13:50:43+05:30",
"updatedAt": "2026-05-03T13:50:43+05:30",
"createdById": 8091,
"updatedById": 8091,
"propertyName": "Warden House Koramangala",
"roomTypeName": "Twin Sharing Room",
"roomTypeBedCount": 2,
"roomAllowedGenders": [],
"roomName": "G01",
"bedName": "A",
"bookingStatus": "Pending",
"allowedGenders": []
}
],
"roomTypesList": "Twin Sharing Room",
"roomsList": "G01 - A",
"user": {
"phone": "+911111990028",
"id": 31973,
"isPhoneVerified": false,
"isEmailVerified": false,
"emailVerificationToken": null,
"registerMethod": "PHONE",
"name": "Test User",
"email": "test.user@wardenera.com",
"gender": null,
"photos": [],
"createdById": 2506,
"createdAt": "2026-05-03T13:50:39+05:30",
"updatedAt": "2026-05-03T13:50:39+05:30",
"isTestAccount": false
},
"planMeta": {
"id": 14678,
"planType": "Fixed",
"planEndDate": "2026-09-18T15:40:41+05:30",
"planInputs": {
"rent": 13500,
"security": 50000,
"reservation": 2500,
"reservationMode": "Full Booking"
},
"displayPlanInputs": {
"rent": 13500,
"bedCount": 1,
"discount": 0,
"security": 50000,
"reservation": 2500
},
"generatorMeModified at 2026-05-03 12:30:12