Crops

This object contains a mix of metadata about the crop, the parcel it's grown on, and specifics about the planting and harvesting timeline.

The crops provides a comprehensive view of a single crop's lifecycle in the rotation plan, from planting to harvest, including specific details about the crop variety and performance metrics. It's a useful structure for an API serving users in agriculture, especially for precision farming applications where managing the details of each crop rotation is crucial for optimizing yield and soil health.

List all crops

get

Returns a paginated list of all active crops accessible to the authenticated user. Results are filtered by the user's farm ownership and ordered by sowing date (newest first). Superusers can see all crops.

Query parameters

parcelintegerOptional

Filter crops by parcel ID

parcel_idintegerOptional

Alternative filter for parcel ID (deprecated, use parcel instead)

Responses

200Success

application/json

401

Unauthorized - Authentication credentials were not provided or are invalid

403

Forbidden - User does not have permission to access this resource

get

/api/crops/

HTTPcURLJavaScriptPython

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

[
  {
    "id": 1,
    "family": {
      "id": 1,
      "key": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "observation": "text"
    },
    "irrigation_type": {
      "id": 1,
      "name": "text"
    },
    "soil_type": {
      "id": 1,
      "name": "text"
    },
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "campaign": "text",
    "area": 1,
    "variety": "text",
    "harvested_qty": 1,
    "sowing": "2026-01-28",
    "closure": "2026-01-28",
    "is_active": true,
    "created": "2026-01-28T06:21:11.996Z",
    "modified": "2026-01-28T06:21:11.996Z",
    "parcel": 1
  }
]

Retrieve a crop

get

Returns the details of a specific crop by its ID. The crop must belong to a parcel on a farm accessible by the authenticated user.

Path parameters

idstringRequired

Responses

200Success

application/json

401

Unauthorized - Authentication credentials were not provided or are invalid

403

Forbidden - User does not have permission to access this crop

404

Not Found - Crop with the specified ID does not exist or is not active

get

/api/crops/{id}/

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "family": {
    "id": 1,
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "observation": "text"
  },
  "irrigation_type": {
    "id": 1,
    "name": "text"
  },
  "soil_type": {
    "id": 1,
    "name": "text"
  },
  "key": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "campaign": "text",
  "area": 1,
  "variety": "text",
  "harvested_qty": 1,
  "sowing": "2026-01-28",
  "closure": "2026-01-28",
  "is_active": true,
  "created": "2026-01-28T06:21:11.996Z",
  "modified": "2026-01-28T06:21:11.996Z",
  "parcel": 1
}

Get crops associated with a parcel

get

Retrieves all active crops associated with a specific parcel, ordered by sowing date (most recent first).

Crop Fields:

• id: Unique identifier

• key: UUID key

• family: Crop family object with id and name

• parcel: ID of the associated parcel

• name: Optional crop name

• campaign: Growing campaign (e.g., '2024/2025')

• variety: Crop variety

• sowing: Sowing date

• closure: Closure/harvest date

• harvested_qty: Harvested quantity

• irrigation_type: Optional irrigation type

• soil_type: Optional soil type

Path parameters

idstringRequired

Responses

200

List of crops associated with the parcel

application/json

404

Parcel not found

get

/api/parcels/{id}/crops/

HTTPcURLJavaScriptPython

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

[
  [
    {
      "id": 123,
      "key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "family": {
        "id": 1,
        "key": "f1e2d3c4-b5a6-7890-dcba-fedcba098765",
        "name": "Wheat",
        "observation": ""
      },
      "parcel": 456,
      "name": "Winter Wheat 2024",
      "campaign": "2024/2025",
      "area": null,
      "variety": "Hard Red Winter",
      "harvested_qty": null,
      "sowing": "2024-10-15",
      "closure": null,
      "is_active": true,
      "irrigation_type": {
        "id": 4,
        "name": "Drip"
      },
      "soil_type": {
        "id": 7,
        "name": "Clay loam"
      },
      "created": "2024-10-15T10:30:00Z",
      "modified": "2024-10-15T10:30:00Z"
    }
  ]
]

Create a new crop

post

Creates a new crop record for a parcel. The crop must be associated with an existing parcel that belongs to a farm accessible by the authenticated user. If no campaign is provided, it defaults to the current year range (e.g., '2026/2027').

Body

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

idintegerRead-onlyRequired

keystring · uuidRead-onlyRequired

namestring · max: 20 · nullableOptional

campaignstring · max: 20 · nullableOptional

areanumber · double · nullableOptional

varietystring · max: 100 · nullableOptional

harvested_qtynumber · double · nullableOptional

sowingstring · date · nullableOptional

closurestring · date · nullableOptional

is_activebooleanOptional

createdstring · date-timeRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

parcelinteger · nullableOptional

Responses

201Success

application/json

400

Bad Request - Invalid data provided (e.g., invalid family, irrigation_type, or soil_type ID)

401

Unauthorized - Authentication credentials were not provided or are invalid

403

Forbidden - User does not have permission to create crops for this parcel

post

/api/crops/

HTTPcURLJavaScriptPython

POST /api/crops/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "family": {
    "id": 1,
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "observation": "text"
  },
  "irrigation_type": {
    "id": 1
  },
  "soil_type": {
    "id": 1
  },
  "name": "text",
  "campaign": "text",
  "area": 1,
  "variety": "text",
  "harvested_qty": 1,
  "sowing": "2026-01-28",
  "closure": "2026-01-28",
  "is_active": true,
  "parcel": 1
}

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

{
  "id": 1,
  "family": {
    "id": 1,
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "observation": "text"
  },
  "irrigation_type": {
    "id": 1,
    "name": "text"
  },
  "soil_type": {
    "id": 1,
    "name": "text"
  },
  "key": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "campaign": "text",
  "area": 1,
  "variety": "text",
  "harvested_qty": 1,
  "sowing": "2026-01-28",
  "closure": "2026-01-28",
  "is_active": true,
  "created": "2026-01-28T06:21:11.996Z",
  "modified": "2026-01-28T06:21:11.996Z",
  "parcel": 1
}

Update a crop

put

Fully updates an existing crop record. All fields will be replaced with the provided values. The crop must belong to a parcel on a farm accessible by the authenticated user.

Path parameters

idstringRequired

Body

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

idintegerRead-onlyRequired

keystring · uuidRead-onlyRequired

namestring · max: 20 · nullableOptional

campaignstring · max: 20 · nullableOptional

areanumber · double · nullableOptional

varietystring · max: 100 · nullableOptional

harvested_qtynumber · double · nullableOptional

sowingstring · date · nullableOptional

closurestring · date · nullableOptional

is_activebooleanOptional

createdstring · date-timeRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

parcelinteger · nullableOptional

Responses

200Success

application/json

400

Bad Request - Invalid data provided (e.g., invalid family, irrigation_type, or soil_type ID)

401

Unauthorized - Authentication credentials were not provided or are invalid

403

Forbidden - User does not have permission to update this crop

404

Not Found - Crop with the specified ID does not exist or is not active

put

/api/crops/{id}/

HTTPcURLJavaScriptPython

PUT /api/crops/{id}/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "family": {
    "id": 1,
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "observation": "text"
  },
  "irrigation_type": {
    "id": 1
  },
  "soil_type": {
    "id": 1
  },
  "name": "text",
  "campaign": "text",
  "area": 1,
  "variety": "text",
  "harvested_qty": 1,
  "sowing": "2026-01-28",
  "closure": "2026-01-28",
  "is_active": true,
  "parcel": 1
}

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

{
  "id": 1,
  "family": {
    "id": 1,
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "observation": "text"
  },
  "irrigation_type": {
    "id": 1,
    "name": "text"
  },
  "soil_type": {
    "id": 1,
    "name": "text"
  },
  "key": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "campaign": "text",
  "area": 1,
  "variety": "text",
  "harvested_qty": 1,
  "sowing": "2026-01-28",
  "closure": "2026-01-28",
  "is_active": true,
  "created": "2026-01-28T06:21:11.996Z",
  "modified": "2026-01-28T06:21:11.996Z",
  "parcel": 1
}

Partially update a crop

patch

Partially updates an existing crop record. Only the provided fields will be updated. The crop must belong to a parcel on a farm accessible by the authenticated user.

Path parameters

idstringRequired

Body

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

idintegerRead-onlyOptional

keystring · uuidRead-onlyOptional

namestring · max: 20 · nullableOptional

campaignstring · max: 20 · nullableOptional

areanumber · double · nullableOptional

varietystring · max: 100 · nullableOptional

harvested_qtynumber · double · nullableOptional

sowingstring · date · nullableOptional

closurestring · date · nullableOptional

is_activebooleanOptional

createdstring · date-timeRead-onlyOptional

modifiedstring · date-timeRead-onlyOptional

parcelinteger · nullableOptional

Responses

200Success

application/json

400

Bad Request - Invalid data provided

401

Unauthorized - Authentication credentials were not provided or are invalid

403

Forbidden - User does not have permission to update this crop

404

Not Found - Crop with the specified ID does not exist or is not active

patch

/api/crops/{id}/

HTTPcURLJavaScriptPython

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

{
  "family": {
    "id": 1,
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "observation": "text"
  },
  "irrigation_type": {
    "id": 1
  },
  "soil_type": {
    "id": 1
  },
  "name": "text",
  "campaign": "text",
  "area": 1,
  "variety": "text",
  "harvested_qty": 1,
  "sowing": "2026-01-28",
  "closure": "2026-01-28",
  "is_active": true,
  "parcel": 1
}

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

{
  "id": 1,
  "family": {
    "id": 1,
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "observation": "text"
  },
  "irrigation_type": {
    "id": 1,
    "name": "text"
  },
  "soil_type": {
    "id": 1,
    "name": "text"
  },
  "key": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "campaign": "text",
  "area": 1,
  "variety": "text",
  "harvested_qty": 1,
  "sowing": "2026-01-28",
  "closure": "2026-01-28",
  "is_active": true,
  "created": "2026-01-28T06:21:11.996Z",
  "modified": "2026-01-28T06:21:11.996Z",
  "parcel": 1
}

Delete a crop

delete

Deletes a crop record. This is a hard delete operation. The crop must belong to a parcel on a farm accessible by the authenticated user.

Path parameters

idstringRequired

Responses

204

No Content - Crop was successfully deleted

401

Unauthorized - Authentication credentials were not provided or are invalid

403

Forbidden - User does not have permission to delete this crop

404

Not Found - Crop with the specified ID does not exist or is not active

delete

/api/crops/{id}/

HTTPcURLJavaScriptPython

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

No content