Skip to main content
GET

Authentication

Requires a key with the crops:read scope. See Authentication.

Query parameters

page
integer
default:"1"
Page number (≥ 1).
limit
integer
default:"20"
Results per page (1–100; values above 100 are clamped to 100).
status
string
Filter by status: planned, planted, growing, harvested, failed.
farmId
string
Filter to crops on a specific farm (UUID).
fieldId
string
Filter to crops on a specific field (UUID).
sort
string
default:"createdAt"
Sort field: createdAt, cropType, plantedArea, plantingDate.
order
string
default:"desc"
Sort direction: asc, desc.

Response

data
array
Array of crop objects.
pagination
object

Errors

StatusWhen
401Missing, malformed, expired, or revoked API key
403Key lacks crops:read scope
429Rate limit reached
5xxServer error