Skip to main content
GET
List Properties

Authorizations

Authorization
string
header
required

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

page
integer

1-based page number. List endpoints return 25 results per page.

Required range: x >= 1
Example:

1

parcelId
string

Return only properties on the parcel with this parcel number. Cannot be combined with geometry.

Example:

"12-34-567-890"

externalSystemId
string

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.

Minimum string length: 1
Example:

"101591177"

hiddenFromPublic
enum<string>

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.

Available options:
true,
false
geometry
string

URI-encoded GeoJSON Polygon. Only properties whose coordinates fall inside the polygon are returned. Cannot be combined with parcelId.

Example:

"{\"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.

errors
object[]
required

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.

Example:
properties
object[]
required

Up to 25 properties for the requested page.

pageInfo
object

Pagination metadata for a list response. Present whenever the request succeeded, and omitted when it failed validation.

Example: