GET /api/action/express-v1/branches

PROD

Este serviço retorna a lista de filiais da sua conta (a imobiliária dona do token). O escopo vem do access token, não é enviado como parâmetro.

Informações do recurso
Autenticação	Obrigatória (Token de API, Bearer)
Scope	`express-base`
Método HTTP	GET
Resposta	JSON
Versão	1

URL do recurso

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

Código de exemplo

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

Resposta

Um documento JSON com a lista de filiais do cliente.

Objeto	Campo	Tipo	Obrigatório	Descrição
Response	branches	Array of Branch	yes	A lista de objetos Branch
Branch	branchId	string	yes	O identificador da filial. É o que você usa para relacioná-la ao `branchId` de um imóvel
	main	boolean	yes	`true` na filial principal. Existe exatamente uma
	seoUrl	string	no	O identificador da filial nas URLs do site do cliente
	name	string	yes	O nome da filial
	address	string	yes	O endereço da filial
	zone0Description	string	yes	O país onde a filial está localizada
	zone1Description	string	yes	O estado ou província da filial
	zone2Description	string	yes	O município da filial (ou bairro em alguns casos)
	zone3Description	string	no	A cidade onde a filial está localizada
	zip	string	yes	O CEP da filial
	phone1	string	yes	Um número de telefone da filial
	phone2	string	no	Um número de telefone alternativo da filial
	phone3	string	no	Um número de telefone alternativo da filial
	mobile	string	no	O celular da filial, em formato internacional sem símbolos (`5411…`). É o que serve para montar um link de WhatsApp
	email	string	yes	O e-mail da filial

Resposta de exemplo

{
    "branches": [
        {
            "zone0Description": "Argentina",
            "zone1Description": "Capital Federal",
            "zone2Description": "Recoleta",
            "address": "Jonte 3939",
            "zip": "1425",
            "branchId": "1798",
            "main": true,
            "phone1": "+54 11 2344-9239",
            "name": "Sucursal Principal",
            "email": "info@customer.com"
        },
        {
            "zone0Description": "Argentina",
            "zone1Description": "Capital Federal",
            "zone2Description": "Palermo",
            "address": "Av Santa Fe 393",
            "zip": "1425",
            "branchId": "2703",
            "main": false,
            "phone1": "+54 11 2323 3343",
            "name": "Sucursal 2",
            "email": "info2@customer.com"
        },
        {
            "zone0Description": "Argentina",
            "zone1Description": "Buenos Aires",
            "zone2Description": "San Miguel",
            "zone2Description": "Bella Vista",
            "address": "Sourdeaux 393",
            "zip": "1445",
            "branchId": "2703",
            "main": false,
            "phone1": "+54 11 6666 3343",
            "name": "Sucursal 3",
            "email": "info3@customer.com"
        }
    ]
}