PUpurplegrain
Properties

Get a property

Changed on

One property: its name and labels, the point the map opens on (centroid_lat / centroid_lon), area_ha with its area_source, the live paddock_count / mob_count, its outline, and its blocks (each block's name, kind, paddock ids, and a derived area and outline).

boundary is an array of closed rings, each an array of [longitude, latitude] pairs — longitude first, never a GeoJSON object — or null while the property has none; boundary_source says how it was captured. Write it with updatePropertyBoundary. The paddocks and mobs on the property, with their own outlines and counts, are getPropertyPicture. Any accepted member of the owning business can read; a personal property is readable by its owner alone.

get/properties/{id}

Request

  • Base URL
    https://api.purplegrain.com/api/v1
  • URL
    https://api.purplegrain.com/api/v1/properties/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Id of the record

Query parameters

includestring
Example:organization

Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; a path outside the allowed list is refused with 400 unknown_include (see the 400 response); max 10 paths. Allowed paths: organization.

Response

Successful

Example response

{
  "data": {
    "type": "property",
    "blocks": [
      {
        "name": "Racecourse block",
        "hull": {
          "type": "Polygon"
        }
      }
    ]
  },
  "_meta": {
    "onboarding": {
      "skill": "pg-onboarding@1"
    }
  }
}

Changes