GET /api/action/mapaprop-chat-ai-v1/featureds

BETA

Returns the featured properties configured on the customer's website. customerId and websiteId are resolved from the access token.

Resource information
Authentication	Required (API Token, Bearer)
HTTP Method	GET
Response	JSON
Version	1
Cache	1 hour

Resource URL

https://mapaprop.app/api/action/mapaprop-chat-ai-v1/featureds

Parameters

Key	Type	Required	Description
max	int	no	Maximum number of featured properties to return. Defaults to `150`

Sample code

GET /api/action/mapaprop-chat-ai-v1/featureds?max=10 HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Response

Object	Field	Type	Required	Description
Response	featureds	Array of Featured	yes	Featured properties of the website
Featured	featuredId	int	yes	ID of the featured record
	propertyId	int	yes	Property ID
	code	string	yes	Property code, with account prefix (e.g. `11099-casas236516`)
	seoUrl	string	yes	SEO path of the property
	title	string	yes	Property title
	description	string	yes	Property description
	typeDesc	string	yes	Translated description of the property type
	propertyTypeDesc	string	yes	Translated description of the property type (alias of `typeDesc`)
	operationDesc	string	yes	Translated description of the operation
	propertyOperationDesc	string	yes	Translated description of the operation (alias of `operationDesc`)
	showPrice	boolean	yes	Whether the customer chose to show the price of this featured property
	price	number	yes	Property price
	currency	string	yes	Currency of the price
	occupancy	int	no	Maximum number of occupants (short-term rental)
	ambiences	int	no	Number of rooms
	rooms	int	no	Number of bedrooms
	bathrooms	int	no	Number of bathrooms (only if declared)
	buildingArea	int	no	Covered surface in m² (only if declared)
	landArea	int	no	Land surface in m² (only if declared)
	sold	boolean	no	Present only if the property is marked as sold
	rented	boolean	no	Present only if the property is marked as rented
	suspended	boolean	no	Present only if the listing is suspended
	reserved	boolean	no	Present only if the property is reserved
	address	string	no	Property address
	addressDesc	string	no	Combination of state, county and city (depending on availability)
	zone1	string	no	State/province name
	zone2	string	no	County/neighborhood name
	zone3	string	no	City name
	thumbnail	string	yes	Full URL of the thumbnail image
	customerCountryDesc	string	yes	Country name of the customer's account

Sample response

{
    "featureds": [
        {
            "featuredId": 40063,
            "propertyId": 2600144,
            "code": "11099-casas236516",
            "seoUrl": "venta-de-departamento-en-palermo-capital-federal-11099-2600144",
            "title": "Departamento 2 ambientes en Palermo",
            "description": "Excelente departamento a estrenar...",
            "typeDesc": "Departamento",
            "propertyTypeDesc": "Departamento",
            "operationDesc": "Venta",
            "propertyOperationDesc": "Venta",
            "showPrice": true,
            "price": 210000,
            "currency": "USD",
            "ambiences": 2,
            "rooms": 2,
            "addressDesc": "Palermo,Capital Federal",
            "zone1": "Capital Federal",
            "zone2": "Palermo",
            "thumbnail": "https://s3.amazonaws.com/mapaprop-dev-image/photos/11099/2600144/1t.jpg",
            "customerCountryDesc": "Argentina"
        }
    ]
}