Farms

Get a property

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 updateFarmBoundary. The paddocks and mobs on the property, with their own outlines and counts, are getFarmPicture. Any accepted member of the owning business can read; a personal property is readable by its owner alone.

get/farms/{id}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/farms/{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; unknown paths ignored; max 10 paths. Allowed paths: organization.

Response

Successful

Example response

{
  "data": {
    "type": "farm",
    "blocks": [
      {
        "name": "Racecourse block",
        "hull": {
          "type": "Polygon"
        }
      }
    ]
  }
}

Changes

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