Skip to main content
GET
endpoint
/api/v1/properties
Retrieve a paginated list of properties with optional filtering.

Query Parameters

parcelId
string
Restricts the resulting properties to those associated with the parcel with the given parcelId. Cannot be used together with geometry.
hiddenFromPublic
enum
Accepts true or false. Controls visibility filtering. Omitting returns both public and private properties.
page
number
Positive, non-zero integer for pagination. See Pagination.
geometry
string
URI-encoded GeoJSON Polygon geometry to filter properties by spatial intersection. Only properties whose coordinates fall within the polygon will be returned. Cannot be used together with parcelId.
Example GeoJSON Polygon
{
  "type": "Polygon",
  "coordinates": [
    [
      [-73.98836883114409, 40.67402149000125],
      [-73.98836883114409, 40.66928110727923],
      [-73.98070752927185, 40.66928110727923],
      [-73.98070752927185, 40.67402149000125],
      [-73.98836883114409, 40.67402149000125]
    ]
  ]
}

Response

properties
array
Array of property objects (up to 25 per page)
pageInfo
object
Pagination information. See Pagination.
errors
array
Array of error objects. See Errors.
curl "https://app.withforerunner.com/api/v1/properties?page=1" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "properties": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "address": "123 Main St, Springfield, IL 62701",
      "publicURL": "https://app.withforerunner.com/public/properties/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "url": "https://app.withforerunner.com/properties/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "coordinates": [39.7817, -89.6501],
      "parcel": {
        "id": "f1e2d3c4-b5a6-7890-dcba-098765432109",
        "parcelId": "12-34-567-890",
        "address": "123 Main St, Springfield, IL 62701"
      }
    }
  ],
  "pageInfo": {
    "page": 1,
    "pageSize": 25,
    "totalCount": 1043,
    "totalPages": 42
  },
  "errors": []
}