List All Properties
Documentation for GET /api/v1/public/properties
endpoint.
- Request
- Success Response
- Error Response
GET https://staging.holidaymate.co/api/v1/public/properties
{
"data": [
{
"id": "72c7e569-12cb-34dc-ac67-5103b143e106",
"title": "Seaside Villa Marbella",
"city": "Marbella",
"country": "ES",
"photo": [
{
"id": "b1f35c9a-9d1c-4a2b-b3e1-8f1a6a5d4f2b",
"url": "https://cdn.example.com/images/5ae78f20-3c11-4c38-87f2-ea9b6d1b0f5d/",
"description": "Front view of the townhouse",
"position": 1
},
]
}
],
"meta": {
"pagination": {
"current_page": 1,
"per_page": 1,
"total_entries": 24
}
}
}
{
"error": {
"code": "INVALID_PAGE_SIZE",
"message": "Maximum page size is 100"
}
}
Query Parameters​
Parameter | Type | Default | Description |
---|---|---|---|
filter[country] | string | - | ISO country code (e.g., US , ES ) |
filter[city] | string | - | Exact city name |
page[number] | integer | 1 | Page number |
page[size] | integer | 25 | Results per page (max 100) |
Response Fields​
data[]
Array of property summary objects:id
(UUID)title
(string)city
(string)country
(ISO code)thumbnail
(URL or null)
meta.pagination
Pagination details:current_page
per_page
total_entries
Example Usage​
curl -G \
-H "X-API-KEY: YOUR_API_KEY" \
"https://staging.holidaymate.co/api/v1/public/properties" \
-d "filter[country]=GR" \
-d "page[size]=5"
Tip: Use this endpoint for search filters before fetching details with
/properties/{id}
.