GET
/
sensors
curl --request GET \
  --url https://api.truecold.io/v1/sensors \
  --header 'x-api-key: <api-key>'
{
  "error": false,
  "data": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "provider_id": "<string>",
      "account_id": "<string>",
      "name": "<string>",
      "serial_number": "<string>",
      "model": "<string>",
      "last_event_at": "<string>",
      "available": false,
      "location_account_id": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
id
string

UUID of the sensor

Example:

"382bc9c0-6a3b-4255-97f4-98e91ceab047"

​
provider_id
string

UUID of the sensor provider

Example:

"382bc9c0-6a3b-4255-97f4-98e91ceab047"

​
name
string

Name of the sensor

Example:

"Berlinger 1"

​
serial_number
string

Sensor serial number

Example:

"G-1234"

​
model
string

Sensor model

Example:

"Berlinger X1V"

​
available
boolean

Sensor availability. If true, the sensor is available.

Example:

true

​
location_account_id
string

UUID of the account where the sensor currently is

Example:

"382bc9c0-6a3b-4255-97f4-98e91ceab047"

​
sort
enum<string>

Sort the sensors by created_at date

Available options:
asc,
desc

Response

200
application/json

The response is of type object.

GET
/
sensors
curl --request GET \
  --url https://api.truecold.io/v1/sensors \
  --header 'x-api-key: <api-key>'
{
  "error": false,
  "data": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "provider_id": "<string>",
      "account_id": "<string>",
      "name": "<string>",
      "serial_number": "<string>",
      "model": "<string>",
      "last_event_at": "<string>",
      "available": false,
      "location_account_id": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
id
string

UUID of the sensor

Example:

"382bc9c0-6a3b-4255-97f4-98e91ceab047"

​
provider_id
string

UUID of the sensor provider

Example:

"382bc9c0-6a3b-4255-97f4-98e91ceab047"

​
name
string

Name of the sensor

Example:

"Berlinger 1"

​
serial_number
string

Sensor serial number

Example:

"G-1234"

​
model
string

Sensor model

Example:

"Berlinger X1V"

​
available
boolean

Sensor availability. If true, the sensor is available.

Example:

true

​
location_account_id
string

UUID of the account where the sensor currently is

Example:

"382bc9c0-6a3b-4255-97f4-98e91ceab047"

​
sort
enum<string>

Sort the sensors by created_at date

Available options:
asc,
desc

Response

200
application/json

The response is of type object.