Parcels

Parcels represent individual agricultural plots or fields within a farm. Each parcel has a geometry (polygon), name, and can include custom metadata for filtering and organization.

Parcel Metadata

The metadata field allows you to attach custom key-value data to any parcel. This is useful for storing information like supplier IDs, regions, crop types, or any other custom attributes your system needs.

Creating Parcels with Metadata

When creating parcels via the API, include a metadata object:

{
  "farm": {"id": 123},
  "parcels": [{
    "name": "Parcel A",
    "metadata": {
      "Supplier ID": "CPS-000111",
      "region": "North",
      "contract_year": "2024"
    },
    "geom": { ... }
  }]
}

Updating Parcel Metadata

Use the PATCH endpoint to update metadata:

PATCH /api/parcels/{parcel_id}/

{
  "id": 12345,
  "metadata": {
    "Supplier ID": "CPS-000111",
    "region": "North",
    "status": "active"
  }
}

Viewing Metadata in Embedded Maps

Metadata is visible in the embedded map in two ways:

1. Parcel tooltips: Users can toggle which metadata fields appear when hovering over a parcel

2. Parcel detail panel: All metadata key-value pairs are displayed when opening a parcel's details

Filtering by Metadata in Embedded Maps

You can filter the embedded map to show only parcels with specific metadata values using URL parameters:

https://embed.graniot.com/?auth_id=YOUR_TOKEN&metadata[Supplier+ID]=CPS-000111

See the Embedded Maps documentation for more filtering options.

---

get

Responses

200Success

application/json

typestring · enumOptional

• FeatureCollection - FeatureCollection

Possible values:

get

/api/parcels/

HTTPcURLJavaScriptPython

GET /api/parcels/ HTTP/1.1
Accept: */*

200Success

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": 1,
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              0,
              0
            ],
            [
              0,
              50
            ],
            [
              50,
              50
            ],
            [
              50,
              0
            ],
            [
              0,
              0
            ]
          ]
        ]
      },
      "bbox": [
        12.9721,
        77.5933,
        12.9721,
        77.5933
      ],
      "properties": {
        "hectares": "text",
        "image_url": "text",
        "wms_url": "text",
        "center": "text",
        "parcelresolution_set": [
          {
            "resolution": 1,
            "last_image_date": "2026-03-24"
          }
        ],
        "deforestation_audit": "text",
        "key": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "is_active": true,
        "metadata": null,
        "computed_attributes": null
      }
    }
  ]
}

post

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

typestring · enumOptionalPossible values:

idintegerRead-onlyOptional

bboxnumber[] · min: 4 · max: 4OptionalExample: [12.9721,77.5933,12.9721,77.5933]

Responses

201Success

application/json

post

/api/parcels/

HTTPcURLJavaScriptPython

POST /api/parcels/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "type": "Feature",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          0,
          0
        ],
        [
          0,
          50
        ],
        [
          50,
          50
        ],
        [
          50,
          0
        ],
        [
          0,
          0
        ]
      ]
    ]
  },
  "bbox": [
    12.9721,
    77.5933,
    12.9721,
    77.5933
  ],
  "properties": {
    "name": "text",
    "is_active": true,
    "metadata": null,
    "computed_attributes": null
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "type": "Feature",
  "id": 1,
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          0,
          0
        ],
        [
          0,
          50
        ],
        [
          50,
          50
        ],
        [
          50,
          0
        ],
        [
          0,
          0
        ]
      ]
    ]
  },
  "bbox": [
    12.9721,
    77.5933,
    12.9721,
    77.5933
  ],
  "properties": {
    "hectares": "text",
    "image_url": "text",
    "wms_url": "text",
    "center": "text",
    "parcelresolution_set": [
      {
        "resolution": 1,
        "last_image_date": "2026-03-24"
      }
    ],
    "deforestation_audit": "text",
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "is_active": true,
    "metadata": null,
    "computed_attributes": null
  }
}

get

Path parameters

idstringRequired

Responses

200Success

application/json

typestring · enumOptionalPossible values:

idintegerRead-onlyOptional

bboxnumber[] · min: 4 · max: 4OptionalExample: [12.9721,77.5933,12.9721,77.5933]

get

/api/parcels/{id}/

HTTPcURLJavaScriptPython

GET /api/parcels/{id}/ HTTP/1.1
Accept: */*

200Success

{
  "type": "Feature",
  "id": 1,
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          0,
          0
        ],
        [
          0,
          50
        ],
        [
          50,
          50
        ],
        [
          50,
          0
        ],
        [
          0,
          0
        ]
      ]
    ]
  },
  "bbox": [
    12.9721,
    77.5933,
    12.9721,
    77.5933
  ],
  "properties": {
    "hectares": "text",
    "image_url": "text",
    "wms_url": "text",
    "center": "text",
    "parcelresolution_set": [
      {
        "resolution": 1,
        "last_image_date": "2026-03-24"
      }
    ],
    "deforestation_audit": "text",
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "is_active": true,
    "metadata": null,
    "computed_attributes": null
  }
}

delete

Path parameters

idstringRequired

Responses

204

No response body

delete

/api/parcels/{id}/

HTTPcURLJavaScriptPython

DELETE /api/parcels/{id}/ HTTP/1.1
Accept: */*

204

No response body

No content

patch

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

namestringOptional

Optional, but cannot be null.

Responses

201Success

application/json

400Error

application/json

patch

/api/parcels/{id}/

HTTPcURLJavaScriptPython

PATCH /api/parcels/{id}/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 361

{
  "id": 55175,
  "name": "AAAABCDD",
  "parcelGeoJson": {
    "type": "FeatureCollection",
    "features": [
      {
        "id": 55175,
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                102.12269467681534,
                5.657402998619716
              ],
              [
                102.12345732318465,
                5.657402998619716
              ],
              [
                102.12345732318465,
                5.656639001375267
              ],
              [
                102.12269467681534,
                5.656639001375267
              ],
              [
                102.12269467681534,
                5.657402998619716
              ]
            ]
          ]
        }
      }
    ]
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Update name only (geometry required)Update geometry and metadataSplit parcel (Polygon + LineString)

{
  "id": 55175,
  "name": "AAAABCDD",
  "parcelGeoJson": {
    "type": "FeatureCollection",
    "features": [
      {
        "id": 55175,
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                102.12269467681534,
                5.657402998619716
              ],
              [
                102.12345732318465,
                5.657402998619716
              ],
              [
                102.12345732318465,
                5.656639001375267
              ],
              [
                102.12269467681534,
                5.656639001375267
              ],
              [
                102.12269467681534,
                5.657402998619716
              ]
            ]
          ]
        }
      }
    ]
  }
}