Get Property Listings
GET
/api/v1/external-app/get-property-listings
Last modified:2026-05-03 12:38:52
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 as a query string. 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 name, type, addressStreet, addressCity, addressCountry, and id |
id | number | Filter by exact property ID |
name | string | Filter by property name |
type | string | Filter by property type (e.g. Mix) |
areaLocationId | number | Filter by area/locality location ID |
cityLocationId | number | Filter by city location ID |
latitide | float | Filter by location latitude |
longitude | float | Filter by location longitude |
Operators
| Operator | Meaning |
|---|---|
:= | Exact match |
~= | Contains (partial match) |
>= | Greater than or equal |
<= | Less than or equal |
!= | Not equal |
Filter Examples
# Filter by name (partial match)
GET /api/v1/external-app/get-property-listings?q=name~=Aston
# Filter by exact property ID
GET /api/v1/external-app/get-property-listings?q=id:=462
# Combine multiple filters
GET /api/v1/external-app/get-property-listings?q=name~=Aston$$type:=MixSorting
| Parameter | Type | Options | Default |
|---|---|---|---|
sort | string | createdAt, updatedAt, name, type, addressCity | name |
order | string | asc, desc | asc |
Additional Parameters
| Parameter | Type | Description |
|---|---|---|
channelId | number | Filter pricing (startingPrice, minPrice, maxPrice) by a specific channel's rates |
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-property-listings' \
--header 'User-Agent: insomnia/11.4.0' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"properties": [
{
"id": 462,
"status": "Live",
"companyId": 11,
"brandId": 2,
"legalEntityId": 22,
"legalEntity": {
"id": 22,
"name": "NISHTA DOZE AND DINE LLP",
"logo": [],
"wordmark": [],
"data": {
"addressStreet": "B 505, Titanium Business Park",
"addressCountry": "India",
"addressCity": "Ahmedabad",
"addressState": "Gujarat",
"addressPincode": "380007",
"pan": "AAYFN4706A",
"gstin": "24AAYFN4706A1ZC",
"cin": "U74999UR2020PTC010632",
"phone": "+913879328892",
"email": "info@cirkle.co.in"
},
"channelId": null,
"companyId": 11,
"isDeleted": false,
"createdById": 8091,
"updatedById": 8091,
"createdAt": "2025-07-24T18:03:09+05:30",
"updatedAt": "2026-03-17T12:20:01+05:30"
},
"rentAgreementTemplateId": null,
"rentAgreementAddendumTemplateId": null,
"photos": [],
"type": "Mix",
"residentType": "Both",
"name": "The Aston - Japandi",
"description": null,
"genders": "Any",
"totalFloors": 1,
"addressStreet": "2 Kay Poh Road",
"addressCountry": "India",
"addressCity": "Singapore",
"addressPincode": "248973",
"addressState": "River Valley",
"locationId": null,
"onboardingStep": 2,
"info": {
"rentalStructure": {
"description": "",
"photos": []
},
"paymentPlan": {
"description": "",
"photos": []
},
"wifi": {
"description": "",
"photos": []
},
"mess": {
"description": "",
"photos": []
},
"payments": {
"description": "",
"photos": []
},
"whatsappNumber": "+917899119911"
},
"note": null,
"localization": {
"countryCode": "sg",
"currency": "SGD",
"language": "en",
"timezone": "Asia/Singapore",
"translations": {}
},
"bookingAutoDiscardConfig": {
"isActive": false,
"expirySeconds": {
"No Beds Assigned": null,
"No Payment Done": null,
"Reservation Payment Pending": null,
"Check-In Payment Pending": null
}
},
"createdById": 8091,
"updatedById": 8091,
"createdAt": "2026-04-10T14:43:36+05:30",
"updatedAt": "2026-04-13T14:09:57+05:30",
"statusKey": 2,
"amenities": [],
"amenityIds": [],
"excludedAmenities": [],
"excludedAmenityIds": [],
"amenityConnections": [],
"fullAddress": "2 Kay Poh Road, Singapore, River Valley, 248973",
"startingPrice": 100,
"minPrice": 100,
"maxPrice": 3500,
"location": null,
"settings": {
"maxAdvanceBookingDays": 30
}
},
{
"id": 454,
"status": "Live",
"companyId": 11,
"brandId": 5,
"legalEntityId": 22,
"legalEntity": {
"id": 22,
"name": "NISHTA DOZE AND DINE LLP",
"logo": [],
"wordmark": [],
"data": {
"addressStreet": "B 505, Titanium Business Park",
"addressCountry": "India",
"addressCity": "Ahmedabad",
"addressState": "Gujarat",
"addressPincode": "380007",
"pan": "AAYFN4706A",
"gstin": "24AAYFN4706A1ZC",
"cin": "U74999UR2020PTC010632",
"phone": "+913879328892",
"email": "info@cirkle.co.in"
},
"channelId": null,
"companyId": 11,
"isDeleted": false,
"createdById": 8091,
"updatedById": 8091,
"createdAt": "2025-07-24T18:03:09+05:30",
"updatedAt": "2026-03-17T12:20:01+05:30"
},
"rentAgreementTemplateId": null,
"rentAgreementAddenduModified at 2026-05-03 12:38:52