Activities
Main Activity Fields
| Field | Value Example | Type | Description | How it Can Be Used |
|---|---|---|---|---|
| id | "c9aeff55-b139-4059-b3d0-5ca484b4ff95" | String (UUID) | Unique identifier for the activity | For referencing and linking activities |
| extra | Object | Additional custom fields | Store activity-specific custom data | |
| assignees | [] | Array | List of users assigned to the activity | Managing task assignments |
| labels | [] | Array | Tags or categories for the activity | Categorization and filtering |
| start_date | "2021-05-06T12:39:36Z" | String (ISO 8601) | Activity start timestamp | Timeline tracking and scheduling |
| end_date | null | String (ISO 8601)|null | Activity end timestamp | Duration tracking |
| attachments | [] | Array | List of attached files/documents | Document management |
| note | "Test Note" | String | Additional information about the activity | Documentation and comments |
| archived_at | null | String (ISO 8601)|null | Archival timestamp | Track when an activity was archived |
| created_at | "2025-01-16T08:27:55Z" | String (ISO 8601) | Creation timestamp | Audit trail |
| updated_at | "2025-01-16T08:27:55Z" | String (ISO 8601) | Last update timestamp | Track modifications times |
Activity Type Object
| Field | Value Example | Type | Description | How it Can Be Used |
|---|---|---|---|---|
| id | "18d38bc4-7650-4cf8-a5a1-d758e42ab487" | String (UUID) | Unique identifier for activity type | Reference specific activity types |
| name | "Activity 492427083" | String | Name of the activity type | Display and categorization |
| canonical_name | "canonical_413785973" | String | Standardized name | System-level identification |
| extra_schema | Object|null | Schema for extra fields | Validate custom fields format | |
| created_at | "2025-01-16T08:27:55Z" | String (ISO 8601) | Creation timestamp | Audit trail |
| updated_at | "2025-01-16T08:27:55Z" | String (ISO 8601) | Last update timestamp | Track modifications |
Some Activities have extra fields that can be used to store additional information. The extra field is present on the Activity object itself, but its schema is dependent on the Activity Type.
In order to get the schema for that ActivityType you have to check the extra_schemafield of the Activity Type.
The GET /activity_types endpoint is the best way to list all the extra formats.
Following are the commonly used extra schemas (refer to the API for the complete, up-to-date list):
Planting Activity Type extra schema
| Field | Type | Description | Constraints |
|---|---|---|---|
| seed_usage | Number | Amount of seeds used | Must be >= 0 |
| seed_usage_unit | String | Unit of measurement for seed usage | Must be either "kg" or "bags" |
Fertilizing Activity extra schema
Contains an array of fertilizers with the following properties per fertilizer:
| Field | Type | Description | Constraints |
|---|---|---|---|
| type | String | Type of fertilizer | Optional. Must be one of: "chemical", "chicken_manure", "cow_manure", "other_organic", "slow_release", "lime", "dolomite" |
| method | String | Application method | Optional. Must be one of: "machine_broadcast", "drone", "sprayer", "human", "drip" |
| nitrogen | Integer | Nitrogen content | Optional. Must be >= 0 |
| phosphorus | Integer | Phosphorus content | Optional. Must be >= 0 |
| potassium | Integer | Potassium content | Optional. Must be >= 0 |
| amount | Number | Amount of fertilizer | Optional. Must be >= 0 |
| amount_unit | String | Unit of measurement | Required if amount is present. Must be either "kg/m2" or "L/m2" |
Harvesting Activity extra schema
| Field | Type | Description | Constraints |
|---|---|---|---|
| harvest | Number | Amount harvested | Optional. Must be >= 0 |
Inspection Activity extra schema
| Field | Type | Description | Constraints |
|---|---|---|---|
| rating | Integer | Inspection rating | Optional. Must be between 1 and 5 |
| estimated_production | Number | Estimated production amount | Optional. Must be >= 0 |
| estimated_area_loss | Number | Estimated area lost | Optional. Must be >= 0 |
| cause_of_loss | String | Reason for loss | Optional. Must be one of: "BY_FLOOD", "BY_DROUGHT", "BY_DISEASE", "BY_WEED", "BY_OTHER" |
Soil Observation Activity extra schema
| Field | Type | Description | Constraints |
|---|---|---|---|
| soil_type | String | Type of soil observed | Optional. Must be one of: "sandy", "sandy_loam", "sandy_clay_loam", "sandy_clay", "loamy_sand", "loamy", "clay_loam", "clay", "silty_clay", "silty_clay_loam", "silty_loam", "silt", "no_data", "other" |
Water Supply Activity extra schema
| Field | Type | Description | Constraints |
|---|---|---|---|
| water_regime_before_planting | String | Water regime before planting period | Optional. Must be one of: "non_flooded_less_than_180_days", "non_flooded_greater_than_180_days", "flooded_greater_than_30_days", "non_flooded_greater_than_365_days" |
| water_regime_while_planting | String | Water regime during planting period | Optional. Must be one of: "irrigated_continuously_flooded", "irrigated_single_drainage", "irrigated_multiple_drainage", "deep_water", "rainfed_regular", "rainfed_drought_prone" |
📄️ Create a new cropzone activity
Creates a activity under cropzone, requires organization write access
📄️ List activities of a cropzone
Get a list of activities associated with the cropzone with `cropzone_id` provided in url
📄️ Delete an activity
Deletes activity. You must have an API token with the `organizations:write` scope.
📄️ Update activity info
Update Activity info. You must have an API token with the `organizations:write` scope.
📄️ activity info
Get activity info
📄️ List activities of a farm
Get a list of activities associated with the farm with `farm_id` provided in urlRequired `organizations:read` scope to access
📄️ List activities of a field
Get a list of activities associated with the field with `field_id` provided in urlRequired `organizations:read` scope to access