Get nearby schools for a property

GET /schools/{locationId}

Get nearby schools for a property

cURL

curl --request GET \
  --url https://app.getaptly.com/api/portal/schools/{locationId}

200

[
  {
    "_id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "rating": 123,
    "distance": 123,
    "address": "<string>",
    "url": "<string>"
  }
]

Path Parameters

locationId · string · required

Query Parameters

distance · integer · default: 25

limit · integer · default: 10

Response

200 - application/json

Array of school objects

_id · string

name · string

type · string

rating · integer

distance · number

address · string

url · string<uri>