Enumerations (measurements, roles, states)

GET /reference/enums

Scope catalog:read
API key x-api-key
Base URL https://api.hub.akuasense.com/v1

Query parameters

lang string

Language of the label fields, and of a probe’s default name (name: “Probe 3”, “Sonde 3”). The code values never vary. A crop with no translation falls back to its French name.

Values: enfr

Default: en

Response

200

Fixed enumerations

measurement_types array of object always present
Show 2 attributes Hide attributes
- code string always present
  
  Quantity measured by a sensor: humidity, soil moisture; temperature, soil temperature; tensio, soil water tension, measured by a tensiometer probe. On input, tension — the former code for tensio — is still accepted.
  
  Values: humiditytemperaturetensio
- label string always present
company_roles array of object always present
Show 2 attributes Hide attributes
- code string always present
  
  A member’s role within a company. OWNER and MANAGER can write, VIEWER only reads. Only an OWNER manages members (scope users:admin).
  
  Values: OWNERMANAGERVIEWER
- label string always present
agronomic_states array of object always present
Show 2 attributes Hide attributes
- code string always present
  
  Soil water status, as returned by GET /modules/{id}/agronomic-state.
  
  Values: saturatedcomfortstress
- label string always present
irrigation_systems array of object always present
Show 2 attributes Hide attributes
- code string always present
  
  Type of equipment. Determines the default wetted soil fraction (FAO-56 table 20): drip 0.35 · micro_sprinkler 0.60 · all others 1.00.
  
  Values: dripmicro_sprinklersprinklerpivotgravitymanualother
- label string always present
irrigation_input_modes array of object always present
Show 2 attributes Hide attributes
- code string always present
  
  How the application is declared. duration requires NO configuration (it is the universal fallback mode) but only yields a dose once the flow rate is known; depth_mm is taken as is; volume_m3 requires the irrigated area.
  
  Values: durationdepth_mmvolume_m3
- label string always present
irrigation_event_statuses array of object always present
Show 2 attributes Hide attributes
- code string always present
  
  planned = scheduled, done = done, skipped = cancelled (never shown on charts).
  
  Values: planneddoneskipped
- label string always present
irrigation_event_sources array of object always present
Show 2 attributes Hide attributes
- code string always present
  
  Where the row comes from. manual = entered in the hub · schedule = occurrence materialized by a schedule · api = this API · mcp = AI assistant. Read-only: the source is set by whichever surface writes the row.
  
  Values: manualscheduleapimcp
- label string always present
irrigation_schedule_freqs array of object always present
Show 2 attributes Hide attributes
- code string always present
  
  Values: dailyweekly
- label string always present
irrigation_confirmation_policies array of object always present
Show 2 attributes Hide attributes
- code string always present
  
  Values: automanual
- label string always present
irrigation_warnings array of object always present
Show 2 attributes Hide attributes
- code string always present
  
  Why the dose could not be computed, or which assumption it rests on. NONE of them is blocking: the watering is recorded whatever happens, waterMm simply staying null.
  
  Values: NO_INSTALLATIONMISSING_FLOW_RATEMISSING_IRRIGATED_AREADEFAULT_FRACTION_WETTED
- label string always present

Errors

401
Not authenticated
403
Insufficient scope, or resource outside your company

GET /reference/enums

curl https://api.hub.akuasense.com/v1/reference/enums \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  'https://api.hub.akuasense.com/v1/reference/enums',
  {
    headers: {
      'x-api-key': 'YOUR_API_KEY',
    },
  },
);
const data = await response.json();

import requests

response = requests.get(
    "https://api.hub.akuasense.com/v1/reference/enums",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()

Response

{
  "measurement_types": [
    {
      "code": "humidity",
      "label": "Humidity"
    },
    {
      "code": "temperature",
      "label": "Temperature"
    },
    {
      "code": "tensio",
      "label": "Tension"
    }
  ],
  "company_roles": [
    {
      "code": "OWNER",
      "label": "Owner"
    },
    {
      "code": "MANAGER",
      "label": "Manager"
    },
    {
      "code": "VIEWER",
      "label": "Viewer"
    }
  ],
  "agronomic_states": [
    {
      "code": "saturated",
      "label": "Saturated"
    },
    {
      "code": "comfort",
      "label": "Comfort"
    },
    {
      "code": "stress",
      "label": "Stress"
    }
  ],
  "irrigation_systems": [
    {
      "code": "drip",
      "label": "Drip"
    },
    {
      "code": "micro_sprinkler",
      "label": "Micro-sprinkler"
    },
    {
      "code": "sprinkler",
      "label": "Sprinkler"
    },
    {
      "code": "pivot",
      "label": "Pivot"
    },
    {
      "code": "gravity",
      "label": "Gravity / flood"
    },
    {
      "code": "manual",
      "label": "Manual watering"
    },
    {
      "code": "other",
      "label": "Other"
    }
  ],
  "irrigation_input_modes": [
    {
      "code": "duration",
      "label": "Duration"
    },
    {
      "code": "depth_mm",
      "label": "Depth (mm)"
    },
    {
      "code": "volume_m3",
      "label": "Volume (m³)"
    }
  ],
  "irrigation_event_statuses": [
    {
      "code": "planned",
      "label": "Planned"
    },
    {
      "code": "done",
      "label": "Done"
    },
    {
      "code": "skipped",
      "label": "Skipped"
    }
  ],
  "irrigation_event_sources": [
    {
      "code": "manual",
      "label": "Manual entry"
    },
    {
      "code": "schedule",
      "label": "Schedule occurrence"
    },
    {
      "code": "api",
      "label": "REST API"
    },
    {
      "code": "mcp",
      "label": "MCP assistant"
    }
  ],
  "irrigation_schedule_freqs": [
    {
      "code": "daily",
      "label": "Every N days"
    },
    {
      "code": "weekly",
      "label": "Chosen weekdays"
    }
  ],
  "irrigation_confirmation_policies": [
    {
      "code": "auto",
      "label": "Auto-confirm past occurrences"
    },
    {
      "code": "manual",
      "label": "Confirm each occurrence by hand"
    }
  ],
  "irrigation_warnings": [
    {
      "code": "NO_INSTALLATION",
      "label": "No irrigation setup covers this date — the watering is recorded without a dose"
    },
    {
      "code": "MISSING_FLOW_RATE",
      "label": "Flow rate missing: a duration cannot be converted into mm"
    },
    {
      "code": "MISSING_IRRIGATED_AREA",
      "label": "Irrigated area missing: a volume cannot be converted into mm"
    },
    {
      "code": "DEFAULT_FRACTION_WETTED",
      "label": "Wetted fraction taken from the system default (FAO-56 table 20)"
    }
  ]
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 401,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 403,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema