Docs
V1 APIConnections

Get neighborhood

The property's address plus its neighborhood categories and places, shaped for a map view. Scoped to the portfolio: `{property}` is a slug resolved against the properties attached to `{connection}`, so a slug outside this portfolio is a `404` rather than another site's property.

GET/api/v1/connection/{connection}/property/{property}/neighborhood

The property's address plus its neighborhood categories and places, shaped for a map view. Scoped to the portfolio: {property} is a slug resolved against the properties attached to {connection}, so a slug outside this portfolio is a 404 rather than another site's property.

Path Parameters

connection*string

Connection UUID.

Formatuuid
property*string

Property slug, resolved against the properties attached to {connection}. A slug outside that portfolio is a 404. Slug only — a UUID does not resolve here.

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/connection/497f6eca-6276-4993-bfeb-53cbbbba6f08/property/1520-gough-street/neighborhood"
{  "apartmentName": "string",  "apartmentAddress": {    "address": "string",    "address2": "string",    "city": "string",    "state": "string",    "zipCode": "string",    "lat": 0,    "lng": 0  },  "categories": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "label": "string",      "color": "string",      "types": [        "string"      ],      "active": true    }  ],  "places": [    {      "name": "string",      "address": "string",      "lat": 0,      "lng": 0,      "category": "string",      "color": "string",      "rating": "string",      "website": "http://example.com",      "googleMapsUrl": "http://example.com",      "driveTime": "string",      "walkTime": "string",      "bikeTime": "string",      "transitTime": "string",      "placeId": "string"    }  ]}