Skip to content
docs

Schedules feeding a probe

GET /modules/{moduleId}/irrigation/schedules
  • Scope irrigation:read
  • API key x-api-key
  • Base URL https://api.hub.akuasense.com/v1

The schedules targeting this probe AND those targeting its parcel: from the probe’s point of view, both are “its” schedules.

Path parameters

  • moduleId integer required

Response

200

Schedules, most recent first

  • module_id integer
  • data array of IrrigationSchedule

    Irrigation turn rule. ⚠️ It is MATERIALIZED into real occurrences in the log (90-day horizon, nightly sweep): a schedule therefore declares water.

    Show 18 attributes Hide attributes
    • id integer
    • targetParcelId integer nullable
    • targetModuleId integer nullable
    • label string nullable
    • freq string
      Values: dailyweekly
    • intervalDays integer nullable

      In daily mode: every N days (1–365). null in weekly mode.

    • weekdays array of integer nullable

      In weekly mode: the days kept, 1 = Monday … 7 = Sunday. null or empty in daily mode.

    • startTimes array of string

      LOCAL start times (HH:MM), 1 to 12 of them. An array, not a single value: automatic irrigation commonly runs morning AND evening.

    • timezone string

      IANA time zone, mandatory and never UTC: 06:00 must stay 06:00 for the customer on either side of the daylight-saving switch.

    • inputMode string

      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
    • durationMin integer nullable
    • inputDepthMm number nullable
    • inputVolumeM3 number nullable
    • startsOn string date
    • endsOn string date nullable
    • confirmationPolicy string

      auto (default): past occurrences flip to done on their own, with verifiedAt at null — so “the schedule says it was watered” stays distinct from “somebody checked”. manual: they stay planned until confirmed.

      Values: automanual
    • isActive boolean
    • materializedUntil string date-time nullable

      How far ahead occurrences have been produced.

Errors

  • 401

    Not authenticated

  • 403

    Insufficient scope, or resource outside your company

  • 404

    Not found