GET /api/action/portal-v2/branches

PROD

Lists the branches the portal can display. Each one includes its address, phone numbers, zone and the number of published properties it has.

Resource information
Authentication	Required
HTTP method	GET
Response	JSON
Version	2

Resource URL

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

Parameters

Key	Type	Required	Description
custId	int	no	Narrows the list to the branches of one agency
seoUrl	string	no	Narrows the list to the branch with that `seoUrl`
from	int	no	Offset for pagination. Defaults to `0`
size	int	no	Number of results to return. Defaults to `50`

Example request

GET /api/action/portal-v2/branches?custId=1019&size=2 HTTP/1.1
Host: mapaprop.app
Authorization: Bearer {access_token}

Response

Object	Field	Type	Description
Response	total	int	Total number of matching branches
Response	branches	Array	The list
Branch	branchId	int	Branch identifier
Branch	name	string	Branch name
Branch	seoUrl	string	Its URL identifier — the one used by `branches/{seoUrl}/properties`
Branch	main	boolean	Whether it is the head office
Branch	propertyCount	int	Published properties belonging to that branch
Branch	address · zip · location	string	Location
Branch	phone1 · phone2 · phone3 · mobile · phones · email	string	Contact details
Branch	zone0…zone2 and their `*Description`	int · string	The zone, by level
Branch	custId · customerName · customerSeoUrl	int · string	The owning agency

Example response

{
    "total": 1,
    "branches": [
        {
            "branchId": 1,
            "name": "Casa Central",
            "seoUrl": "inmobiliaria-ciocale",
            "main": true,
            "propertyCount": 48,
            "customerSeoUrl": "ciocale-inmobiliaria",
            "zone1Description": "Capital Federal"
        }
    ]
}