Skip to content
docs

List the company's 4G gateways

GET /gateways
  • Scope readings:read
  • API key x-api-key
  • Base URL https://api.hub.akuasense.com/v1

All the gateways attached to the company, including those carrying no probe in service — GET /modules does not show them. Sorted by identifier.

Query parameters

  • cursor string

    Opaque pagination cursor

  • limit integer
    Default: 50
  • search string

    Fragment of a serial number or IMEI, case-insensitive: 65F9 finds the gateway whose serial number ends that way.

  • 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

The company’s gateways

  • data array of Gateway always present

    A 4G gateway attached to the company: it is the one powering the probes and transmitting their measurements. Its state comes from its last transmission, with the same thresholds as GatewayHealth.

    Show 10 attributes Hide attributes
    • id integer always present

      Identifier of the gateway — the currentGateway.id of its modules.

    • imei string always present

      IMEI of the gateway’s modem.

    • serialHex string nullable always present

      Serial number printed on the gateway’s label, 24 hexadecimal characters. null: no serial number is recorded for this gateway — this is the case for the oldest ones.

    • firmware string nullable always present

      Version of the gateway’s software, for example 2.5.2. null until the gateway has transmitted it.

    • assignedAt string date-time always present

      Date the gateway was attached to the company.

    • status string always present

      faulty: no transmission for more than 25 hours, or none so far.

      Values: activefaulty
    • lastSeen string date-time nullable always present

      Last transmission. null: the gateway has not transmitted anything yet.

    • soc integer nullable always present

      Estimated battery charge, %, derived from its voltage at the last transmission. null if the voltage is unknown.

    • level integer nullable always present

      Network signal quality at the last transmission, in bars, from 0 to 4. null if unknown.

    • modules array of object always present

      The company’s modules plugged into this gateway — the ones GET /modules returns with this gateway as currentGateway. Empty: no probe in service on this gateway, for example a gateway registered but not yet installed.

      Show 4 attributes Hide attributes
      • id integer always present

        Identifier of the module, to pass to the /modules/{id} routes.

      • uid string always present

        Technical identifier of the module.

      • name string nullable always present

        Name of the probe, like Module.name: it follows lang.

      • category string nullable always present
        Values: SOIL_PROBETENSIOMETERWEATHER_STATIONnull
  • next_cursor string nullable always present

    Cursor for the next page, to be passed back as is in cursor. null: last page.

Errors

  • 401

    Not authenticated

  • 403

    Insufficient scope, or resource outside your company