Public
Public properties

Look up a person's property by slug

Look up one property of a person, by their handle and the property slug, in one call: the visitor view of the place, its mapped paddocks, its mobs, its tasks and its records. Works with no credentials when the property is public or shared by link (pass share). A stranger with no credentials gets 404. A signed-in caller who may not see it gets 403.

The address is the web address with the API prefix, and the web address's .json form is this call with the include below. resolveLink is the step that turns a pasted link into these slugs.

  • Visibility is the property's own, as for resolveLink: members read it, anyone reads a public property, and a link-shared one needs its share token. A caller with no credentials who may not read it gets a 404, the same as for one that does not exist; a signed-in caller who may not gets a 403.
  • Only paddocks with a boundary are listed, and only rows filed on a listed paddock or mob (or on the property itself) are returned: nothing from archived or unmapped assets, nothing from another property.
  • It follows the shared-link privacy rules: the place is the town and state, never the street or postcode, and nothing says who a task was shared with. The treatment register is never in it.
  • Cacheable for a minute for callers with no credentials.
get/users/{owner}/properties/{property}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/users/{owner}/properties/{property}
  • Auth: one of:
    • none
    • HTTP bearer

Path parameters

ownerstring required

The person's handle.

propertystring required

The property's slug. A slug it used to have still finds it.

Query parameters

includestring
Example:paddocks,mobs,tasks,records

Comma-separated sections to return with the property: paddocks, mobs, tasks, records. The property alone when absent. Unknown names are ignored.

sharestring

The property's share token, when it is shared by link.

Response

The property, with the requested sections.

idstring
namestring
slugstring
visibility'private' | 'link' | 'public'
web_pathstring

The property's own address on the web.

locationstring nullable

Town and state, e.g. Antwerp VIC. Null when the label is only a street.

area_hanumber nullable
centroid_latnumber nullable
centroid_lonnumber nullable
boundary_sourcestring nullable
paddock_countinteger
mob_countinteger

Changes

No recorded changes to this operation across all 4 revisions of this API.