List Properties
Returns properties in your account, 25 per page.
Narrow the results by parcel with parcelId, or to an area with a GeoJSON geometry polygon. The two filters cannot be combined.
Look up a single property by your own identifier with externalSystemId. It returns at most one property and can be combined with any other filter.
This endpoint is only available on accounts with the property table enabled. Without it every request is rejected with a 400 and Listing properties is not enabled on your account. Contact support to have it turned on.
Authorizations
Your account's API key, sent as Authorization: Bearer <your API key>. Keys are issued per environment, so a staging key will not work against production.
Query Parameters
1-based page number. List endpoints return 25 results per page.
x >= 11
Return only properties on the parcel with this parcel number. Cannot be combined with geometry.
"12-34-567-890"
Return only the property with this identifier from your system. External system IDs are unique within your account, so at most one property is returned.
1"101591177"
true returns only properties hidden from the public site, false only properties visible on it. Omit to return both. Use false when displaying properties publicly.
true, false URI-encoded GeoJSON Polygon. Only properties whose coordinates fall inside the polygon are returned. Cannot be combined with parcelId.
"{\"type\":\"Polygon\",\"coordinates\":[[[-89.66,39.78],[-89.64,39.78],[-89.64,39.79],[-89.66,39.79],[-89.66,39.78]]]}"
Response
Success. errors is empty.
Empty when the request succeeded. Otherwise one entry per failure, and the resource fields on the response are empty: null for single resources, [] for lists, with pageInfo omitted.
Up to 25 properties for the requested page.
Pagination metadata for a list response. Present whenever the request succeeded, and omitted when it failed validation.