GET /api/action/portal-v2/customers

PROD

Este serviço retorna a lista de clientes (imobiliárias) do portal. Suporta busca por texto, filtros geográficos e paginação. Apenas clientes ativos e verificados são retornados.

Se seu cliente possui o scope network-suscription, os resultados são restritos aos clientes da sua rede. Caso contrário, a busca abrange todos os clientes.

Informações do recurso
Autenticação	Required
Scope	`internal-portal`
Método HTTP	GET
Resposta	JSON
Versão	2

URL do recurso

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

Exemplo de chamada

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

Chave	Tipo	Obrigatório	Descrição
term	string	no	Termo de busca que tenta corresponder a pelo menos 3 caracteres no campo `name` do cliente. Busca de texto completo.
from	int	no	Índice de início para paginação. Padrão 0
size	int	no	Quantidade de resultados a retornar. Padrão 20
countryId	int	no	Filtro por ID do país. Constantes
stateId	int	no	Filtro por ID de estado ou província
countyId	int	no	Filtro por ID de município
cityId	int	no	Filtro por ID de cidade

Resposta

Um documento JSON com a lista de clientes que correspondem aos filtros aplicados.

Objeto	Campo	Tipo	Obrigatório	Descrição
Response	took	int	yes	Tempo que a busca levou em milissegundos
	total	int	yes	Total de registros disponíveis neste contexto de busca. Você pode paginar por eles
	filters	Object	yes	Filtros aplicados à busca (inclui um objeto `country` com id e descrição quando um filtro de país é usado, e `term` quando há busca por texto)
	customers	Array of customers	yes	Lista de objetos cliente. Cada cliente inclui o perfil público da agência: id, nome, logo, endereço, informações de zona e dados de contato

Exemplo de resposta

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