Get Residents
GET
/api/v1/external-app/get-residents
Last modified:2026-05-03 12:32:14
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 resident name, phone, email, and room name, or by exact id |
id | number | Filter by exact resident ID |
userId | number | Filter by the user ID of the resident |
bookingId | number | Filter residents belonging to a specific booking |
propertyId | number | Filter residents by property |
sessionId | number | Filter by session ID |
roomId | number | Filter residents currently occupying a specific room |
roomTypeId | number | Filter residents by room type |
bedId | number | Filter residents by specific bed |
status | enum | Filter by resident status (see values below) |
checkInDate | datetime | Filter by check-in date |
checkOutDate | datetime | Filter by check-out date |
moveInDate | datetime | Filter by move-in date |
moveOutDate | datetime | Filter by move-out date |
createdAt | datetime | Filter by record creation date |
updatedAt | datetime | Filter by last updated date |
isPhoneVerified | boolean | Filter by whether the resident's phone is verified (true or false) |
isAppDownloaded | boolean | Filter by whether the resident has downloaded the Warden app (true or false) |
isExtensionBookingAmountPaid | boolean | Filter by whether the extension booking amount has been paid |
isEligibleForSecurityRefund | boolean | Filter by whether the resident is eligible for a security refund |
isRoomChecked | boolean | Filter by whether the room has been checked during offboarding |
isSecurityRefundPending | boolean | Filter residents whose security refund has not yet been processed |
isTermEnding | boolean | Filter residents whose term is ending soon and have not yet initiated move-out. Only true is a valid value |
isMovingOut | boolean | Filter residents who are in the process of moving out (either Moved Out status or Approved with move-out initiated) |
isExtending | boolean | Filter residents with an active extension lead (true) or without one (false) |
extensionLeadId | number | Filter by a specific extension lead ID |
status Enum Values
| Value | Description |
|---|---|
Draft | Resident created in a draft booking |
Pending | Resident onboarding is in progress |
Approved | Resident has checked in and stay is active |
Rejected | Resident was rejected |
Moved Out | Resident has completed their stay and checked out |
Operators
| Operator | Meaning |
|---|---|
:= | Exact match |
~= | Contains (partial match) |
>= | Greater than or equal |
<= | Less than or equal |
!= | Not equal |
Filter Examples
# Get all active residents at a property
GET /api/v1/external-app/get-residents?q=propertyId:=412$$status:=Approved
# Search by resident phone number
GET /api/v1/external-app/get-residents?q=searchText~=+9198801
# Get residents moving out soon
GET /api/v1/external-app/get-residents?q=isTermEnding:=true
# Get residents with a pending security refund
GET /api/v1/external-app/get-residents?q=isSecurityRefundPending:=true
# Get residents in a specific room
GET /api/v1/external-app/get-residents?q=roomId:=13327Sorting
| Parameter | Type | Options | Default |
|---|---|---|---|
sort | string | createdAt, updatedAt, checkInDate, checkOutDate, moveInDate, moveOutDate | 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-residents' \
--header 'User-Agent: insomnia/11.4.0' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"residents": [
{
"id": 57363,
"bookingId": 12321,
"propertyId": 20,
"companyId": 11,
"userId": 31446,
"kycId": null,
"fileName": null,
"status": "Rejected",
"type": "Student",
"onboardingData": {
"isFormFilled": false,
"isKycDone": false,
"isContractSigned": false,
"isAppDownloaded": false,
"isBookingPaymentDone": false,
"isCheckInPaymentDone": false
},
"offboardingData": {},
"formData": {},
"moveInDate": "2026-04-01T00:00:00+05:30",
"moveOutDate": "2026-09-30T23:59:59+05:30",
"termStartDate": "2026-04-01T00:00:00+05:30",
"termEndDate": "2026-09-30T23:59:59+05:30",
"checkedInAt": null,
"checkedOutAt": null,
"isMovingOut": null,
"noticePeriodDays": null,
"wifiData": null,
"note": null,
"legal": null,
"originalTimezone": "Asia/Kolkata",
"checkInTaskId": null,
"checkOutTaskId": null,
"createdById": 8091,
"updatedById": 13581,
"createdAt": "2026-04-21T13:12:03+05:30",
"updatedAt": "2026-04-24T13:12:01+05:30",
"sessionId": null,
"isTestAccount": false,
"planMeta": null,
"session": null,
"isCheckOutOverdue": false,
"isCheckInOverdue": false,
"isTermEnding": false,
"moveOutNoticeDate": "2026-09-30T23:59:59+05:30",
"displayStatus": "Rejected",
"statusKey": 3,
"occupancies": [],
"user": {
"phone": "+911131334444",
"id": 31446,
"isPhoneVerified": false,
"isEmailVerified": false,
"emailVerificationToken": null,
"registerMethod": "PHONE",
"name": "Test Booking",
"email": null,
"gender": "Male",
"photos": [],
"createdById": 2506,
"createdAt": "2026-04-21T13:05:36+05:30",
"updatedAt": "2026-04-21T13:05:36+05:30",
"isTestAccount": false
},
"bedAssignments": [],
"bedIds": [],
"beds": [],
"roomName": "",
"roomTypeName": "",
"roomsList": "",
"roomTypesList": "",
"propertyName": "Warden House HSR",
"userName": "Test Booking",
"userPhone": "+911131334444",
"userEmail": null,
"statusTransitions": [],
"displayMoveInDate": "Apr 1, 2026",
"displayMoveOutDate": "Sep 30, 2026",
"contracts": [
{
"id": 53915,
"type": "Resident Rent Agreement",
"description": "Booking Resident Rent Agreement",
"startDate": "2026-04-01T00:00:00+05:30",
"endDate": "2026-09-30T23:59:59+05:30",
"signedAt": null,
"signatureNote": null,
"signature": [],
"signatureData": null,
"expiredAt": null,
"expirationNote": null,
"companyId": 11,
"propertyId": 20,
"contractTemplateId": 123,
"createdById": 8091,
"updatedById": 8091,
"createdAt": "2026-04-21T13:12:08+05:30",
"updatedAt": "2026-04-21T13:12:08+05:30",
"documents": [
{
"id": 315705,
"status": "Ready",
"type": "PDF",
"name": "rent_agreement_53915_1776757334",
"extension": ".pdf",
"contentType": "application/pdf",
"tags": null,
"paymentId": null,
"transactionId": null,
"contractId": 53915,
"taskId": null,
"propertyId": null,
"roomTypeId": null,
"amenityId": null,
"bookingId": null,
"logoBrandId": null,
"wordmarkBrandId": null,
"logoLegalEntityId": null,
"wordmarkLegalEntityId": null,
"url": "https://d4jiabh6qs3x1.cloudfront.net/company_11/contracts_53915/rent_agreement_53915_1776757334.pdf?Expires=1778401468&Key-Pair-Id=K16RJR5Modified at 2026-05-03 12:32:14