Guides
Estates
Welcome to Parkvadrata API!
Getting started
The Estates resource provides access to all real estate listings associated with your agency.
Using this endpoint, you can retrieve up-to-date information about each property, including title, description, location, price, images, and related agent data. You can also filter and paginate results to efficiently handle large datasets.
Example of one estate body.
Json body
{
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.886Z",
"updatedAt": "2025-10-23T11:39:28.886Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"realEstateTypeId": 0,
"realEstateType": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.886Z",
"updatedAt": "2025-10-23T11:39:28.886Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string"
},
"parentId": 0,
"name": "string",
"description": "string",
"currency": "string",
"distinctIdentifier": "string",
"price": 0,
"oldPrice": 0,
"minPrice": 0,
"maxPrice": 0,
"rentalPrice": 0,
"typeOfUse": "string",
"stars": 0,
"isInactive": true,
"cityId": 0,
"city": "string",
"destination": "string",
"address": "string",
"latitude": 0,
"longitude": 0,
"parentName": "string",
"slug": "string",
"year": 0,
"squareFeet": 0,
"floors": 0,
"locatedAtFloor": 0,
"isFavorite": true,
"objectTypeId": 0,
"objectType": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.886Z",
"updatedAt": "2025-10-23T11:39:28.886Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string"
},
"rating": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.886Z",
"updatedAt": "2025-10-23T11:39:28.886Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"stayId": 0,
"totalRating": 0,
"ratingsCount": 0
},
"agencyName": "string",
"agencyCity": "string",
"agencyAddress": "string",
"instagramUrl": "string",
"tikTokUrl": "string",
"youtubeUrl": "string",
"youtubeVideoUrl": "string",
"imageGallery": [
{
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"stayId": 0,
"imageGalleryId": 0,
"imageGallery": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"projectId": 0,
"project": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string",
"description": "string",
"companyId": "string",
"anyField": "string",
"relJobCategoryCompanyId": 0,
"relJobCategoryCompany": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"categoryId": 0,
"category": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string",
"parentCategoryId": 0,
"image": "string"
},
"companyId": "string",
"value": "string",
"maxValue": "string",
"anyField": "string"
},
"imageGalleries": [
null
]
},
"images": [
null
]
},
"thumbnailImageUrl": "string",
"mediumImageUrl": "string",
"imageUrl": "string",
"isCoverImage": true,
"fileSize": 0,
"fileType": "string",
"width": 0,
"height": 0,
"title": "string",
"altText": "string",
"metaKeywords": "string"
}
],
"documents": [
{
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"stayId": 0,
"name": "string",
"documentUrl": "string"
}
],
"filters": [
{
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"realEstateId": 0,
"filterGroupId": 0,
"filterGroup": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string",
"sortOrder": 0,
"objectTypeId": 0,
"objectType": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string"
},
"filters": [
{
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string",
"iconName": "string",
"filterGroupId": 0,
"valueEnabled": true,
"sortOrder": 0,
"objectTypeId": 0
}
]
},
"filterId": 0,
"filter": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string",
"iconName": "string",
"filterGroupId": 0,
"valueEnabled": true,
"sortOrder": 0,
"objectTypeId": 0
},
"value": 0
}
],
"units": [
null
],
"isFeatured": true,
"publishType": "string",
"isFeaturedUntil": "2025-10-23T11:39:28.887Z",
"badgeName": "string",
"userName": "string",
"externalId": "string",
"views": 0,
"country": "string",
"agentId": "string",
"flatCount": 0,
"garageCount": 0,
"officeSpaceCount": 0,
"embed360Url": "string"
}Estates
Welcome to Parkvadrata API!
Getting started
The Estates resource provides access to all real estate listings associated with your agency.
Using this endpoint, you can retrieve up-to-date information about each property, including title, description, location, price, images, and related agent data. You can also filter and paginate results to efficiently handle large datasets.
Example of one estate body.
Json body
{
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.886Z",
"updatedAt": "2025-10-23T11:39:28.886Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"realEstateTypeId": 0,
"realEstateType": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.886Z",
"updatedAt": "2025-10-23T11:39:28.886Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string"
},
"parentId": 0,
"name": "string",
"description": "string",
"currency": "string",
"distinctIdentifier": "string",
"price": 0,
"oldPrice": 0,
"minPrice": 0,
"maxPrice": 0,
"rentalPrice": 0,
"typeOfUse": "string",
"stars": 0,
"isInactive": true,
"cityId": 0,
"city": "string",
"destination": "string",
"address": "string",
"latitude": 0,
"longitude": 0,
"parentName": "string",
"slug": "string",
"year": 0,
"squareFeet": 0,
"floors": 0,
"locatedAtFloor": 0,
"isFavorite": true,
"objectTypeId": 0,
"objectType": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.886Z",
"updatedAt": "2025-10-23T11:39:28.886Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string"
},
"rating": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.886Z",
"updatedAt": "2025-10-23T11:39:28.886Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"stayId": 0,
"totalRating": 0,
"ratingsCount": 0
},
"agencyName": "string",
"agencyCity": "string",
"agencyAddress": "string",
"instagramUrl": "string",
"tikTokUrl": "string",
"youtubeUrl": "string",
"youtubeVideoUrl": "string",
"imageGallery": [
{
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"stayId": 0,
"imageGalleryId": 0,
"imageGallery": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"projectId": 0,
"project": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string",
"description": "string",
"companyId": "string",
"anyField": "string",
"relJobCategoryCompanyId": 0,
"relJobCategoryCompany": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"categoryId": 0,
"category": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string",
"parentCategoryId": 0,
"image": "string"
},
"companyId": "string",
"value": "string",
"maxValue": "string",
"anyField": "string"
},
"imageGalleries": [
null
]
},
"images": [
null
]
},
"thumbnailImageUrl": "string",
"mediumImageUrl": "string",
"imageUrl": "string",
"isCoverImage": true,
"fileSize": 0,
"fileType": "string",
"width": 0,
"height": 0,
"title": "string",
"altText": "string",
"metaKeywords": "string"
}
],
"documents": [
{
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"stayId": 0,
"name": "string",
"documentUrl": "string"
}
],
"filters": [
{
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"realEstateId": 0,
"filterGroupId": 0,
"filterGroup": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string",
"sortOrder": 0,
"objectTypeId": 0,
"objectType": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string"
},
"filters": [
{
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string",
"iconName": "string",
"filterGroupId": 0,
"valueEnabled": true,
"sortOrder": 0,
"objectTypeId": 0
}
]
},
"filterId": 0,
"filter": {
"id": 0,
"userId": "string",
"createdAt": "2025-10-23T11:39:28.887Z",
"updatedAt": "2025-10-23T11:39:28.887Z",
"isDeleted": true,
"files": [
"string"
],
"plans": [
"string"
],
"file": "string",
"plan": "string",
"name": "string",
"iconName": "string",
"filterGroupId": 0,
"valueEnabled": true,
"sortOrder": 0,
"objectTypeId": 0
},
"value": 0
}
],
"units": [
null
],
"isFeatured": true,
"publishType": "string",
"isFeaturedUntil": "2025-10-23T11:39:28.887Z",
"badgeName": "string",
"userName": "string",
"externalId": "string",
"views": 0,
"country": "string",
"agentId": "string",
"flatCount": 0,
"garageCount": 0,
"officeSpaceCount": 0,
"embed360Url": "string"
}