Lister les boîtiers 4G de la société

GET /gateways

• Scope readings:read
• Clé API x-api-key
• URL de base https://api.hub.akuasense.com/v1

Tous les boîtiers rattachés à la société, y compris ceux qui ne portent aucune sonde en service — GET /modules ne les laisse pas voir. Triés par identifiant.

Paramètres de requête

• cursor string

  Curseur de pagination opaque

• limit integer
  Par défaut : 50
• search string

  Fragment de numéro de série ou d’IMEI, casse indifférente : 65F9 retrouve le boîtier dont le numéro de série finit ainsi.

• lang string

  Langue des label, et du nom par défaut d’une sonde (name : « Probe 3 », « Sonde 3 »). Les code ne varient jamais. Une culture sans traduction retombe sur son nom français.

  Valeurs : enfr
  Par défaut : en

Réponse

200

Boîtiers de la société

• data tableau de Gateway toujours présent

  Un boîtier 4G rattaché à la société : c’est lui qui alimente les sondes et transmet leurs mesures. Son état vient de sa dernière transmission, avec les mêmes seuils que GatewayHealth.

  Afficher les 10 attributs Masquer les attributs

  • id integer toujours présent

    Identifiant du boîtier — le currentGateway.id de ses modules.

  • imei string toujours présent

    IMEI du modem du boîtier.

  • serialHex string peut être null toujours présent

    Numéro de série imprimé sur l’étiquette du boîtier, 24 caractères hexadécimaux. null : aucun numéro de série n’est enregistré pour ce boîtier — c’est le cas des plus anciens.

  • firmware string peut être null toujours présent

    Version du logiciel du boîtier, par exemple 2.5.2. null tant qu’il ne l’a pas transmise.

  • assignedAt string date-time toujours présent

    Date de rattachement du boîtier à la société.

  • status string toujours présent

    faulty : aucune transmission depuis plus de 25 heures, ou aucune à ce jour.

    Valeurs : activefaulty
  • lastSeen string date-time peut être null toujours présent

    Dernière transmission. null : le boîtier n’a encore rien transmis.

  • soc integer peut être null toujours présent

    Charge estimée de la batterie, %, déduite de sa tension à la dernière transmission. null si la tension est inconnue.

  • level integer peut être null toujours présent

    Qualité du signal réseau à la dernière transmission, en barres, de 0 à 4. null si inconnue.

  • modules tableau d’object toujours présent

    Les modules de la société branchés sur ce boîtier — ceux que GET /modules rend avec ce boîtier en currentGateway. Vide : aucune sonde en service sur ce boîtier, par exemple un boîtier enregistré mais pas encore installé.

    Afficher les 4 attributs Masquer les attributs

    • id integer toujours présent

      Identifiant du module, à passer aux routes /modules/{id}.

    • uid string toujours présent

      Identifiant technique du module.

    • name string peut être null toujours présent

      Nom de la sonde, comme Module.name : il suit lang.

    • category string peut être null toujours présent
      Valeurs : SOIL_PROBETENSIOMETERWEATHER_STATIONnull
• next_cursor string peut être null toujours présent

  Curseur de la page suivante, à repasser tel quel dans cursor. null : dernière page.

Erreurs

• 401

  Non authentifié

• 403

  Scope insuffisant ou ressource hors société

GET /gateways

cURL JavaScript Python

curl https://api.hub.akuasense.com/v1/gateways \
  -H "x-api-key: VOTRE_CLE_API"

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

import requests

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

Réponse

200 401 403

{
  "data": [
    {
      "id": 190,
      "imei": "DEMO-GW-005",
      "serialHex": null,
      "firmware": null,
      "assignedAt": "2026-09-07T19:25:22.930Z",
      "status": "faulty",
      "lastSeen": "2026-09-09T12:30:10.000Z",
      "soc": 90,
      "level": 1,
      "modules": [
        {
          "id": 255,
          "uid": "DEMO-MOD-007",
          "name": "Probe 2",
          "category": "SOIL_PROBE"
        }
      ]
    },
    {
      "id": 191,
      "imei": "DEMO-GW-006",
      "serialHex": null,
      "firmware": null,
      "assignedAt": "2026-09-07T19:29:08.135Z",
      "status": "active",
      "lastSeen": "2026-10-13T14:58:45.000Z",
      "soc": 78,
      "level": 3,
      "modules": [
        {
          "id": 256,
          "uid": "DEMO-MOD-008",
          "name": "Probe 1",
          "category": "SOIL_PROBE"
        }
      ]
    }
  ],
  "next_cursor": null
}

application/json

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

application/problem+json · exemple généré depuis le schéma

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

application/problem+json · exemple généré depuis le schéma