Saltar al contenido principal

Tanks

Available endpoints

GET /v1/tanks/:id

GET /v1/tanks

The tank object​

This object represents a tank. You can retrieve it to view tank details.

Attributes​

id string

Unique identifier for the object.

assigned_device_id string

The tank's assigned device id.

capacity number

The tank's total capacity.

capacity_unit string

The tank's volume measurement unit: liters or gallons.

created_at string

ISO for datetime when the object was created.

custom_id nullable string

Personalized ID for internal customer use.

location object

Location information associated with Tank.

location.city nullable string

The city where the tank is located.

location.country nullable string

The country where the tank is located.

location.district nullable string

The district where the tank is located.

location.latitude nullable number

The latitude coordinate of the tank's location.

location.longitude nullable number

The longitude coordinate of the tank's location.

location.postal_code nullable string

The postal code of the tank's location.

location.region nullable string

The region or state where the tank is located.

location.street nullable string

The street name of the tank's location.

location.street_number nullable string

The street number of the tank's location.

min_fill_alert_percentage integer

Specifies the minimum fill percentage threshold at which the system will trigger a low fill alert to notify the customer.

name string

The tank's name.

owner_id string

The tank owner's customer ID.

updated_at string

ISO for datetime indicates when a tank's data field was last changed.

use_case nullable string

The tank's usage type: residential, commercial, or industrial.

More attributes​

object string

String representing the object's type. Objects of the same type share the same value.

Response​

{
  "id":"849f32cc-e891-4279-ac41-37fe5b2cce50",
  "object":"tank",
  "assigned_device_id":"ABCD1234",
  "capacity":100,
  "capacity_unit":"liters",
  "created_at":"2025-08-13T16:38:55.453Z",
  "custom_id": null,
  "location":{
    "city":null,
    "country":null,
    "district":null,
    "latitude":null,
    "longitude":null,
    "postal_code":null,
    "region":null,
    "street":null,
    "street_number":null
  },
  "min_fill_alert_percentage": 30,
  "name":"My tank",
  "owner_id":"16ccb4b5-2f9d-43c4-aa97-faebe4800904",
  "updated_at":"2025-08-13T16:38:55.453Z",
  "use_case": null
}