Skip to main content
GET
The versioned /api/v1/farms endpoint is the API-key-authenticated path for managing farms. The list operation returns paginated farms owned by the authenticated user; the create operation persists a new farm under that user.

List farms

Authentication

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

Query parameters

integer
default:"1"
Page number (≥ 1).
integer
default:"20"
Results per page (1–100; values above 100 are clamped to 100).
string
Filter by farm status: active, inactive, archived, draft.
string
default:"createdAt"
Sort field: createdAt, name, totalArea.
string
default:"desc"
Sort direction: asc, desc.

Response

Returns paginated farm records.
array
Array of farm objects.
object

Create farm

Authentication

Requires a key with the farms:write scope.

Request body

string
required
1–200 characters.
string
required
1–200 characters.
string
required
1–200 characters.
number
required
Positive number.
string
default:"hectare"
One of hectare, acre, feddan.
string
One of commercial, organic, mixed, specialty.
string
One of crops, livestock, mixed, research.
string
Up to 200 characters.
string
One of drip, sprinkler, flood, pivot, manual, none.
number
Between −90 and 90.
number
Between −180 and 180.
object
GeoJSON Polygon ({ type: "Polygon", coordinates: number[][][] }).
string
default:"active"
One of active, inactive, archived, draft.

Response

Returns the created farm wrapped under data.

Errors

Authentication

Scopes, key format, rate limits

Pagination

Iterator patterns for list endpoints

Errors

Canonical error response shape

API Keys

Manage keys from your dashboard