Unlocks and reports

List unlocked properties

The properties your team has unlocked, newest first, as PropCode's report history lists them: what each is unlocked as, who unlocked it and when, and its Rapid Planning Reports with their ids and share links. How to find a property or a report again without its id. Filter by address or title id, by what it was unlocked as, or to the properties the key's owner unlocked (mine). Test keys list nothing. Free.

get/v1/unlocks

Request

  • Base URL
    https://app.propcode.com.au/api
  • Auth
    HTTP bearer

Query parameters

addressstring

Only properties whose address or title id contains this.

product'pro' | 'cdc' | 'rpr'

Only properties your team unlocked as this: pro, or the cdc or rpr credits of a plan from before Core and Pro.

mineboolean

true: only properties the key's owner unlocked. Otherwise every property your team unlocked. Either way, each property shows everything your team holds on it: its products, who last unlocked it, and all its Rapid Planning Reports.

pageinteger

From 1.

limitinteger

Properties a page, up to 100.

Response

Your team's unlocked properties, a page at a time.

object'list' required
pagenumber required
limitnumber required
totalnumber required

How many properties match, across every page.

Changes

No recorded changes to this operation across all 1 revision of this API.