Farms

This entity represents a farm with specific attributes. Here's a revised brief description:

• name: This field is a string representing the name of the farm. It serves as an identifier or label for the farm, allowing users or systems to reference it by a human-readable name.

• type: The type field is a string indicating the classification or category of the farm.

• is_active: A boolean value that denotes whether the farm is currently active. An active status implies that the farm is operational, engaging in agricultural activities or production.

Deleting Farms

When you delete a farm, all parcels associated with that farm are also deleted. This is a cascade delete operation.

DELETE /api/farms/{farm_id}/

Orphan Farms Warning

If you unlink a farm from an account using the Graniot App UI (by deselecting it from the account's farm list), the farm becomes "orphaned" - it still exists and counts toward billing, but is no longer accessible via the API or visible in the UI.

To manage orphan farms:

1. Go to Settings > Data Management in the Graniot App

2. View all farms associated with your organization, including orphans

3. Permanently delete any unwanted farms from this panel

Note: Billing is based on total hectares across all farms, including orphaned ones. Always delete farms properly instead of just unlinking them.

get

Responses

200

No response body

No content

get

/api/farms/

HTTPcURLJavaScriptPython

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

200

No response body

No content

post

Responses

201Success

application/json

post

/api/farms/

HTTPcURLJavaScriptPython

POST /api/farms/ HTTP/1.1
Accept: */*

201Success

{
  "id": 1,
  "name": "text",
  "type": "ARR",
  "is_active": true,
  "farm_group": {
    "id": 1,
    "name": "text"
  },
  "total_hectares": "text"
}

get

Path parameters

idstringRequired

Responses

200

No response body

No content

get

/api/farms/{id}/

HTTPcURLJavaScriptPython

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

200

No response body

No content

patch

Path parameters

idstringRequired

Responses

200

No response body

No content

patch

/api/farms/{id}/

HTTPcURLJavaScriptPython

PATCH /api/farms/{id}/ HTTP/1.1
Accept: */*

200

No response body

No content

delete

Path parameters

idstringRequired

Responses

204

No response body

delete

/api/farms/{id}/

HTTPcURLJavaScriptPython

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

204

No response body

No content

Deleting a farm will also delete all parcels associated with it.

get

Path parameters

idstringRequired

Responses

200

No response body

No content

get

/api/farms/{id}/parcels/

HTTPcURLJavaScriptPython

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

200

No response body

No content