List alert rules
curl --request GET \
--url https://api.hellotracks.com/v1/alerts/configs \
--header 'API-Key: <api-key>'import requests
url = "https://api.hellotracks.com/v1/alerts/configs"
headers = {"API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-Key': '<api-key>'}};
fetch('https://api.hellotracks.com/v1/alerts/configs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hellotracks.com/v1/alerts/configs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hellotracks.com/v1/alerts/configs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hellotracks.com/v1/alerts/configs")
.header("API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hellotracks.com/v1/alerts/configs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"id": "1700000000001",
"createdAt": 1761900000000,
"title": "Late at warehouse",
"description": "Did not check in at the warehouse",
"action": "no_check_in",
"actionCode": 4,
"actionLabel": "Does not check in",
"duration": "",
"intervalMs": 0,
"memberIds": [
"a1b2c3"
],
"teamIds": [],
"placeIds": [
"d4e5f6"
],
"andPlaceIds": [],
"zoneIds": [],
"zones": [],
"emails": [
"dispatch@example.com"
],
"email": "dispatch@example.com",
"phone": "",
"slackChannelId": "",
"weekdays": 31,
"weekdayNames": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"timeStart": "08:00",
"timeEnd": "09:00",
"timeStartCode": 800,
"timeEndCode": 900,
"status": 0,
"statusText": "active",
"type": 1,
"typeText": "regular",
"companyUid": "c0c0c0"
}
]
},
"error": null,
"meta": {
"path": "/v1/alerts/configs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "invalid_request",
"message": "date must be YYYY-MM-DD"
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "invalid_api_key",
"message": "Invalid Hellotracks API key."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "forbidden",
"message": "No permission."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "throttled",
"message": "Too many requests."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "internal_error",
"message": "Hellotracks API is temporarily unavailable."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}Alerts
List alert rules
Lists the company’s alert rules. Without status only active rules are returned; all = active and paused (not deleted). Admins, operators and the company key may call it; workers get 403.
GET
/
alerts
/
configs
List alert rules
curl --request GET \
--url https://api.hellotracks.com/v1/alerts/configs \
--header 'API-Key: <api-key>'import requests
url = "https://api.hellotracks.com/v1/alerts/configs"
headers = {"API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-Key': '<api-key>'}};
fetch('https://api.hellotracks.com/v1/alerts/configs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hellotracks.com/v1/alerts/configs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hellotracks.com/v1/alerts/configs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hellotracks.com/v1/alerts/configs")
.header("API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hellotracks.com/v1/alerts/configs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"id": "1700000000001",
"createdAt": 1761900000000,
"title": "Late at warehouse",
"description": "Did not check in at the warehouse",
"action": "no_check_in",
"actionCode": 4,
"actionLabel": "Does not check in",
"duration": "",
"intervalMs": 0,
"memberIds": [
"a1b2c3"
],
"teamIds": [],
"placeIds": [
"d4e5f6"
],
"andPlaceIds": [],
"zoneIds": [],
"zones": [],
"emails": [
"dispatch@example.com"
],
"email": "dispatch@example.com",
"phone": "",
"slackChannelId": "",
"weekdays": 31,
"weekdayNames": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"timeStart": "08:00",
"timeEnd": "09:00",
"timeStartCode": 800,
"timeEndCode": 900,
"status": 0,
"statusText": "active",
"type": 1,
"typeText": "regular",
"companyUid": "c0c0c0"
}
]
},
"error": null,
"meta": {
"path": "/v1/alerts/configs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "invalid_request",
"message": "date must be YYYY-MM-DD"
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "invalid_api_key",
"message": "Invalid Hellotracks API key."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "forbidden",
"message": "No permission."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "throttled",
"message": "Too many requests."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "internal_error",
"message": "Hellotracks API is temporarily unavailable."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}Authorizations
Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login.
Query Parameters
Which rules: active (default), paused (or archived), deleted, all (active + paused), or a numeric status 0-2.
Available options:
active, paused, archived, deleted, all, 0, 1, 2