V2 APINeighborhood Places
List neighborhood places
GET
/api/v2/neighborhood-placesAuthorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
account_id?string
Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.
Format
uuidper_page?integer
Range
1 <= value <= 200Default
15property_id?string
Format
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/neighborhood-places"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5", "neighborhood_category_id": "7d46d7f0-a5a9-4d2f-bd33-15cc1d73380e", "name": "string", "address": "string", "rating": "string", "lat": 0, "lng": 0, "url": "string", "place_id": "string", "drive_time": "string", "walk_time": "string", "transit_time": "string", "bike_time": "string", "sort_order": 0, "tags": [ null ], "images": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "url": "string", "thumb_url": "string", "full_url": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ], "reference_url": "string", "reference_id": "string", "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5", "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901" } ], "category": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "color": "string" } } ], "links": { "first": "string", "last": "string", "prev": "string", "next": "string" }, "meta": { "current_page": 0, "from": 0, "last_page": 0, "links": [ { "url": "string", "label": "string", "page": 0, "active": true } ], "path": "string", "per_page": 200, "to": 0, "total": 0 }}