GET /api/action/portal-v2/customers

PROD

Este servicio devuelve la lista de clientes (inmobiliarias) del portal. Soporta búsqueda por texto, filtros geográficos y paginación. Solo se devuelven clientes activos y verificados.

Si tu cliente tiene el scope network-suscription, los resultados se limitan a los clientes de tu red. De lo contrario, la búsqueda abarca todos los clientes.

Información del recurso
Autenticación	Required
Scope	`internal-portal`
Método HTTP	GET
Respuesta	JSON
Versión	2

URL del recurso

https://mapaprop.app/api/action/portal-v2/customers

Ejemplo de llamada

GET /api/action/portal-v2/customers?countyId=222&cityId=53&from=0&size=20 HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Parámetros

Clave	Tipo	Requerido	Descripción
term	string	no	Término de búsqueda que intenta coincidir con al menos 3 caracteres en el campo `name` del cliente. Búsqueda de texto completo.
from	int	no	Índice de inicio para paginación. Por defecto 0
size	int	no	Cantidad de resultados a devolver. Por defecto 20
countryId	int	no	Filtro por ID de país. Constantes
stateId	int	no	Filtro por ID de provincia o estado
countyId	int	no	Filtro por ID de partido o condado
cityId	int	no	Filtro por ID de ciudad

Respuesta

Un documento JSON con la lista de clientes que coinciden con los filtros aplicados.

Objeto	Campo	Tipo	Requerido	Descripción
Response	took	int	yes	Tiempo que tardó la búsqueda en milisegundos
	total	int	yes	Total de registros disponibles en el contexto de esta búsqueda. Podés paginar a través de ellos
	filters	Object	yes	Filtros aplicados a la búsqueda (incluye un objeto `country` con id y descripción cuando se usa filtro de país, y `term` cuando se usa búsqueda por texto)
	customers	Array of customers	yes	Lista de objetos cliente. Cada cliente incluye el perfil público de la agencia: id, nombre, logo, dirección, información de zona y datos de contacto

Ejemplo de respuesta

{
  "took": 11,
  "total": 197,
  "filters": [...],
  "customers": [
    {
      "customerId": 123,
        ...
    }
  ]
}