Public
Resolve

Resolve a shareable address

Turns the slugs in a shareable address into the records they name, and says what the caller may do there:

/organizations/hillcrest/properties/yarrabee/paddocks/north-block?share=k9f2qa is kind=organization&owner=hillcrest&property=yarrabee&paddock=north-block&share=k9f2qa.

  • access.can_edit comes from the session's role in the owner, never from the address.
  • A slug a property, paddock or mob used to have resolves to it with redirect: true and the current canonical_path, so a link shared before a rename still arrives.
  • Public (credentials optional). A caller with no credentials who may not see the property gets a 404, the same as for one that does not exist, so a stranger cannot confirm that a private property is there. A signed-in caller who may not gets a 403 (You don't have access…).
  • resolved.preview carries the facts behind a link preview (an SMS or chat card, a search snippet, the Share panel): the owner's name and, for the deepest thing the address names, its counts, area and (a mob) withholding. It is built after the access check, so a viewer and a link holder read the same facts; a stranger who gets the 404 never sees any.
get/resolve

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/resolve
  • Auth: one of:
    • none
    • HTTP bearer

Query parameters

kind'organization' | 'user' required

Whose address it is.

ownerstring required

The business slug or the person's handle.

propertystring
paddockstring

A paddock slug under property.

mobstring

A mob slug under property.

sharestring

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

Response

What the address names and what the caller may do there.

Changes

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