Skip to main content

activities

Main Activity Fields

FieldValue ExampleTypeDescriptionHow it Can Be Used
id"c9aeff55-b139-4059-b3d0-5ca484b4ff95"String (UUID)Unique identifier for the activityFor referencing and linking activities
extraObjectAdditional custom fieldsStore activity-specific custom data
assignees[]ArrayList of users assigned to the activityManaging task assignments
labels[]ArrayTags or categories for the activityCategorization and filtering
start_date"2021-05-06T12:39:36Z"String (ISO 8601)Activity start timestampTimeline tracking and scheduling
end_datenullString (ISO 8601)|nullActivity end timestampDuration tracking
attachments[]ArrayList of attached files/documentsDocument management
note"Test Note"StringAdditional information about the activityDocumentation and comments
archived_atnullString (ISO 8601)|nullArchival timestampTrack when an activity was archived
created_at"2025-01-16T08:27:55Z"String (ISO 8601)Creation timestampAudit trail
updated_at"2025-01-16T08:27:55Z"String (ISO 8601)Last update timestampTrack modifications times

Activity Type Object

FieldValue ExampleTypeDescriptionHow it Can Be Used
id"18d38bc4-7650-4cf8-a5a1-d758e42ab487"String (UUID)Unique identifier for activity typeReference specific activity types
name"Activity 492427083"StringName of the activity typeDisplay and categorization
canonical_name"canonical_413785973"StringStandardized nameSystem-level identification
extra_schemaObject|nullSchema for extra fieldsValidate custom fields format
created_at"2025-01-16T08:27:55Z"String (ISO 8601)Creation timestampAudit trail
updated_at"2025-01-16T08:27:55Z"String (ISO 8601)Last update timestampTrack 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

FieldTypeDescriptionConstraints
seed_usageNumberAmount of seeds usedMust be >= 0
seed_usage_unitStringUnit of measurement for seed usageMust be either "kg" or "bags"

Fertilizing Activity extra schema

Contains an array of fertilizers with the following properties per fertilizer:

FieldTypeDescriptionConstraints
typeStringType of fertilizerOptional. Must be one of: "chemical", "chicken_manure", "cow_manure", "other_organic", "slow_release", "lime", "dolomite"
methodStringApplication methodOptional. Must be one of: "machine_broadcast", "drone", "sprayer", "human", "drip"
nitrogenIntegerNitrogen contentOptional. Must be >= 0
phosphorusIntegerPhosphorus contentOptional. Must be >= 0
potassiumIntegerPotassium contentOptional. Must be >= 0
amountNumberAmount of fertilizerOptional. Must be >= 0
amount_unitStringUnit of measurementRequired if amount is present. Must be either "kg/m2" or "L/m2"

Harvesting Activity extra schema

FieldTypeDescriptionConstraints
harvestNumberAmount harvestedOptional. Must be >= 0

Inspection Activity extra schema

FieldTypeDescriptionConstraints
ratingIntegerInspection ratingOptional. Must be between 1 and 5
estimated_productionNumberEstimated production amountOptional. Must be >= 0
estimated_area_lossNumberEstimated area lostOptional. Must be >= 0
cause_of_lossStringReason for lossOptional. Must be one of: "BY_FLOOD", "BY_DROUGHT", "BY_DISEASE", "BY_WEED", "BY_OTHER"

Soil Observation Activity extra schema

FieldTypeDescriptionConstraints
soil_typeStringType of soil observedOptional. 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

FieldTypeDescriptionConstraints
water_regime_before_plantingStringWater regime before planting periodOptional. 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_plantingStringWater regime during planting periodOptional. Must be one of: "irrigated_continuously_flooded", "irrigated_single_drainage", "irrigated_multiple_drainage", "deep_water", "rainfed_regular", "rainfed_drought_prone"