PROD

Devuelve las propiedades que el cliente marcó como destacadas para su sitio web, en el orden que él eligió.

Información del recurso
AutenticaciónRequerida (Token de API, Bearer)
Scopeexpress-base
Método HTTPGET
RespuestaJSON
Versión1

URL del recurso

https://mapaprop.app/api/action/express-v1/featureds

Código de ejemplo

GET /api/action/express-v1/featureds HTTP/1.1
Host: mapaprop.app
Authorization: Bearer {access_token}

Parámetros

NombreTipoRequeridoDescripción
fromintnoDesde qué destacada empezar. Por omisión 0. Sirve para pedir la segunda página, la tercera, etc.
sizeintnoCuántas destacadas devolver. Por omisión 20, que es también el máximo; por encima de ese valor el servicio responde con un error.

Respuesta

Un documento JSON con la misma forma que GET /api/action/express-v1/properties: la elección del cliente es un filtro y un orden, no otro tipo de objeto, así que las propiedades llegan con los mismos campos y se pueden mostrar con el mismo código.

🔴 El orden importa y es el que el cliente definió en su panel. La lista llega ya ordenada: no hay que reordenarla.

Una propiedad destacada que no esté publicada —vendida, suspendida o despublicada— simplemente no aparece. Destacar define qué se muestra primero, no si se puede mostrar.

Si el cliente no marcó ninguna destacada, la respuesta es la lista vacía, con la misma forma.

Si hay más de 20

El campo total dice cuántas destacadas tiene el sitio en total, no cuántas trae esta respuesta. Si total es mayor que las propiedades que recibiste, pedí la página siguiente con from:

GET /api/action/express-v1/featureds?from=0&size=20
GET /api/action/express-v1/featureds?from=20&size=20

Un from más allá de la última destacada devuelve la lista vacía con el total real, no un error.

⚠️ Una página puede traer menos propiedades que el size que pediste: las destacadas que no están publicadas no vuelven (ver arriba). Por eso hay que paginar mirando total, y no esperar que cada página venga completa.

Respuesta de ejemplo

{
  "took": 3,
  "total": 9,
  "properties": [
    {
      "propertyId": 2603801,
      "code": "1-AB1234",
      "title": "...",
      "propertyOperation": "...",
      "propertyType": "...",
      "price": 185000,
      "currency": "USD",
      "photos": ["https://images.mapaprop.app/photos/1/2603801/3025164.jpg"]
    }
  ]
}