GET /api/action/network-v1/get-customers

PROD

Este webservice retorna a lista completa de clientes e suas informações entre aqueles relacionados à rede do consumidor da API.

Informações do recurso
Autenticação	Obrigatória
Scope	`network-suscription`
Método HTTP	GET
Resposta	JSON
Versão	1

URL do recurso

https://mapaprop.app/api/action/network-v1/get-customers

Parâmetros

Chave	Tipo	Obrigatório	Descrição
agencyId	string	não	O ID da imobiliária específica que você deseja recuperar. Útil quando você é notificado de que um novo cliente foi adicionado à sua rede.

Código de exemplo

GET /api/action/network-v1/get-customers HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Resposta

Uma lista de clientes em um array pertencente à rede do consumidor, em formato JSON.

Objeto	Campo	Tipo	Obrigatório	Descrição
Customer	agencyId	string	sim	O ID da imobiliária na Mapaprop
	name	string	sim	O nome da imobiliária
	logo	string	sim	A URL do logotipo da imobiliária
	bio	string	não	A descrição da imobiliária
	address	string	sim	Endereço postal da imobiliária
	neighborhood	string	não	Bairro onde a imobiliária está localizada
	city	string	sim	Cidade onde a imobiliária está localizada
	state	string	sim	Estado ou província onde a imobiliária está localizada
	country	string	sim	País da imobiliária
	zipcode	string	sim	CEP da imobiliária
	email	string	sim	O e-mail principal da imobiliária
	phone1	string	sim	O telefone principal da imobiliária
	phone2	string	não	O telefone secundário da imobiliária
	phone3	string	não	O terceiro telefone da imobiliária
	mobile	string	não	O número de celular da imobiliária, para mensagens instantâneas
	url	string	não	O site da imobiliária
	entity	string	não	Pessoa jurídica registrante
	registration	string	não	ID na pessoa jurídica registrante
	tempRental	boolean	não	Se a imobiliária se dedica exclusivamente a locações temporárias

Código de exemplo

[
    {
        "agencyId": "ECID00128401EN",
        "email": "info@tuweb.com",
        "name": "Servicios Inmobiliarios",
        "phone1": "15-1111111",
        "mobile": "541166662222",
        "address": "San Martin 111",
        "country": "Argentina",
        "state": "Capital Federal",
        "city": "Congreso",
        "zipcode": "C1038AAZ",
        "registration": "181818",
        "entity": "CPI",
        "url": "www.tuweb.com",
        "tempRental": false,
        "bio": "Empresa de servicios inmobiliarios.",
        "logo": "https://images.mapaprop.app/mapaprop-image/logos/1/logo.gif"
    }
]