Returns the currently featured property for the given zones. Featuring works by campaign: if no campaign is active for those zones, the response comes back without data.
| Resource information | |
|---|---|
| Authentication | Required |
| HTTP method | GET |
| Response | JSON |
| Version | 2 |
Resource URL
https://mapaprop.app/api/action/portal-v2/featureds
Parameters
| Key | Type | Required | Description |
|---|---|---|---|
| zones | list | no | The zones to look for a featured property in. The parameter may be repeated |
Example request
GET /api/action/portal-v2/featureds?zones=Capital%20Federal HTTP/1.1
Host: mapaprop.app
Authorization: Bearer {access_token}
Response
| Object | Field | Type | Description |
|---|---|---|---|
| Response | success | boolean | Always present |
| Response | data | Object | The featured property. Absent when none is running |
A missing data is not an error: it means no featuring campaign is active for those zones right
now. Your integration has to handle that case.
Example response
{
"success": true
}