GET
/
alerts
curl --request GET \
  --url https://api.truecold.io/v1/alerts \
  --header 'x-api-key: <api-key>'
{
  "error": false,
  "data": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "handling_unit_id": "<string>",
      "min_temp": 123,
      "max_temp": 123,
      "excursion_minutes": 123,
      "account_id": "<string>",
      "owner_id": "<string>",
      "delivery_id": "<string>",
      "shipment_id": "<string>",
      "code": 123,
      "status": "<string>",
      "trigger": "<string>",
      "temperature_range_id": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-api-key
string
required

API Key for authentication

Query Parameters

​
id
string

UUID of the alert

Example:

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

​
min_temp_range
number

Minimum temperature allowed in the temperature range, values lower than this one will increase the excursion_minutes

Example:

"2"

​
max_temp_range
number

Filter the alerts only showing the ones that have a minimum temperature greater than this value

Example:

"8"

​
excursion_minutes
string

Filter the alerts only showing the ones that have a maximum temperature lower than this value

Example:

"10"

​
code
number

The code of the alert

Example:

"292"

​
status
enum<string>

The status of the alert

Available options:
INVALID,
OPEN,
IN_PROGRESS,
DONE
Example:

"OPEN"

​
sort
enum<string>

Sort the alerts by created_at date

Available options:
asc,
desc
Example:

"asc"

Response

200
application/json
​
error
boolean
Example:

false

​
data
object[]