Fields
Field Object
A field represents a geographical area that can contain one or more Cropzones.
Fields serve as a base template for creating Cropzones, which are specific areas within the field dedicated to growing crops. While fields themselves don't have crops assigned to them, Cropzones do. This allows for flexible crop management - for example, you can divide a single field into multiple Cropzones to grow different crops simultaneously in different areas.
Cropzones are designed to manage the lifecycle of crops within a field. When a crop is harvested in a Cropzone, that zone can be renewed for the next growing cycle with the same or different crop, while the field remains as a persistent container. This system enables efficient tracking of crop rotations and growing seasons within the same geographical boundaries.
| Field | Value Example | Type | Description | How it Can Be Used |
|---|---|---|---|---|
| id | "3f53e9db-8d67-4d1c-b81b-f6932691b319" | String (UUID) | Unique identifier for the field | Reference specific fields |
| farm_id | "96cf60d4-69a5-471f-b21d-7da50190a9e7" | String (UUID) | ID of the associated farm | Farm relationship tracking |
| name | "field name" | String | Field name (supports international characters) | Display and identification |
| area | 4702 | Number | Size of field | Area calculations and planning |
| area_unit | "m2" | String | Unit of measurement for area | Area unit standardization |
| note | null | String | null | Additional information | Free text field for comments |
| timezone | "Asia/Bangkok" | String | Timezone of field location | Time-based calculations |
| location.centroid | { type: "Point", coordinates: [99.638, 16.367, 65.114] } | Object | Center point of field with elevation | Location reference and elevation data |
| location.boundary | { type: "Polygon", coordinates: [[...]] } | Object | Polygon defining the field boundaries | Area definition and mapping |
| crops_summary | [{ id: "...", name: "...", variety: "..." }] | Array[Object] | Summary of crops currently growing | Current growth info |
| preview_uri | "https://maps.googleapis.com/maps/api/staticmap?..." | String | Google Maps static image URL | Visual preview of the field |
| archived_at | null | String (ISO 8601) | null | Timestamp when field was archived | Track archived fields |
| created_at | "2025-01-21T06:22:45Z" | String (ISO 8601) | Creation timestamp | Audit trail |
| updated_at | "2025-01-21T06:22:45Z" | String (ISO 8601) | Last update timestamp | Track modifications |
📄️ Create a new field
Creates a field under farm
📄️ List of fields
Get a list of all fields associated with the farm with `farm_id` provided in urlRequired `organizations:read` scope to access
📄️ Delete a field
Delete Fields. You must have an API token with `organizations:write` scope.
📄️ field info
Get field info
📄️ Archive a field
Archive Fields. You must have an API token with `organizations:write` scope.
📄️ Unarchive an archived field
Unarchive an archived field. You must have an API token with the `organizations:admin` or `organizations:write` scope.
📄️ Get fields of an Organization
Get the fields of an Organization
📄️ Get fields of an Organization in geojson format
Get the fields of an Organization in geojson format