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 '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": 19,
"status": "Live",
"companyId": 11,
"brandId": 6,
"legalEntityId": null,
"legalEntity": null,
"rentAgreementTemplateId": null,
"rentAgreementAddendumTemplateId": null,
"photos": [
{
"id": 287415,
"status": "Ready",
"type": "Image",
"name": "1773075237405Whisk_36db65f78aec6e2b108440e08788d5f2dr.jpeg",
"extension": "jpeg",
"contentType": "image/jpeg",
"tags": null,
"paymentId": null,
"transactionId": null,
"contractId": null,
"taskId": null,
"propertyId": 19,
"roomTypeId": null,
"amenityId": null,
"bookingId": null,
"logoBrandId": null,
"wordmarkBrandId": null,
"logoLegalEntityId": null,
"wordmarkLegalEntityId": null,
"url": "https://d4jiabh6qs3x1.cloudfront.net/company_11/properties_19/1773075237405Whisk_36db65f78aec6e2b108440e08788d5f2dr.jpeg?Expires=1778855473&Key-Pair-Id=K16RJR5G26NUQ&Signature=AaiOzNAJHovUzoXcp6KOq1sWFWvhEkiMUyHXrK3cGSPrvngwWXwXeCdSqD7qL89urk1VCvB9TKIZSUSItTQDSQOldREKuh3TozJrmuikXb8IpTA37oz0z6lx7--PeenmoWa7jwMOSvme9hT4YP11izWMpF4BxDggg8BGBMFk~aiM7nDAgoM7NvyJcnXnLtEk9z-kQgerjiRVeWrckcpeEJNyftHQdvXa8mqqdt53JXTYRluZmd7DXpa51etoZDpTzWqXO2YLHNgzXSTAuO0gQIShQMQEId6G8hmJPn0xm16bdGKoCi3siyZCd79XvDSyxtDkV8UEUFSqE6gpQYOIEQ__",
"path": "company_11/properties_19/1773075237405Whisk_36db65f78aec6e2b108440e08788d5f2dr.jpeg",
"uploadUrl": "https://arden-production.s3.ap-south-1.amazonaws.com/company_11/properties_19/1773075237405Whisk_36db65f78aec6e2b108440e08788d5f2dr.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAXYKJWREF7AJWZEAM%2F20260309%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20260309T165918Z&X-Amz-Expires=60&X-Amz-Signature=643e8a7c970a6eb2a81151569cbf292e4a158a1887fa4edab7a0490609ff6cfb&X-Amz-SignedHeaders=host&x-id=PutObject",
"expiresAt": "2026-03-16T21:29:19+05:30",
"createdById": 64081,
"updatedById": 64081,
"createdAt": "2026-03-09T22:29:18+05:30",
"updatedAt": "2026-03-09T22:29:18+05:30"
},
{
"id": 287416,
"status": "Ready",
"type": "Image",
"name": "1773075237403Whisk_b6e9a34f7e0fe7da98f426b5f60bbcd7dr.jpeg",
"extension": "jpeg",
"contentType": "image/jpeg",
"tags": null,
"paymentId": null,
"transactionId": null,
"contractId": null,
"taskId": null,
"propertyId": 19,
"roomTypeId": null,
"amenityId": null,
"bookingId": null,
"logoBrandId": null,
"wordmarkBrandId": null,
"logoLegalEntityId": null,
"wordmarkLegalEntityId": null,
"url": "https://d4jiabh6qs3x1.cloudfront.net/company_11/properties_19/1773075237403Whisk_b6e9a34f7e0fe7da98f426b5f60bbcd7dr.jpeg?Expires=1778855473&Key-Pair-Id=K16RJR5G26NUQ&Signature=ukwNF1NNha95M2zExSyn5M7gTsP0l1Xxsq5sP9XunMr9GUOK~TL5kufrvzB1cVulAmtHueDmytCbQOQbyIdx5WwrVyrVFTzHEWX80ihk9lbASDwGT6jNg56hqnAUpmyR-GguHneuhYEln7iGsg21NE8pLFHQBwRdiry03zga2V25GmOxB8~1xjPHOQJKo8E9Ek87SxPsJIvY0GIyvY-5Phf0LZv1i-NE4H9R172cryZbB83VVWiu0mouhrHy7lyrTEvfTocnZvFidiRWUbcHlSCxis8IqMK6qHOp9QBLgsHgiaQMBX-VLZBOhk1U9wr1bncSGEWnIZtTBRoebV422g__",
"path": "company_11/properties_19/1773075237403Whisk_b6e9a34f7e0fe7da98f426b5f60bbcd7dr.jpeg",
"uploadUrl": "https://arden-production.s3.ap-south-1.amazonaws.com/company_11/properties_19/1773075237403Whisk_b6e9a34f7e0fe7da98f426b5f60bbcd7dr.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAXYKJWREF7AJWZEAM%2F20260309%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20260309T165918Z&X-Amz-Expires=60&X-Amz-Signature=cd548d48e98a3fbe4966bf3c3d51016982d2dfc56a9d6253f8b23e00ec5cdab0&X-Amz-SignedHeaders=host&x-id=PutObject",
"expiresAt": "2026-03-16T21:29:19+05:30",
"createdById": 64081,
"updatedById": 64081,
"createdAt": "2026-03-09T22:29:18+05:30",
"updatedAt": "2026-03-09T22:29:18+05:30"
},
{
"id": 287417,
"status": "Ready",
Modified at 2026-05-03 12:38:52