Add a member
curl --request POST \
--url https://api.hellotracks.com/v1/members \
--header 'API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"username": "alex@example.com",
"name": "Alex Rivera",
"phone": "+1 415 555 0101",
"role": "worker",
"teams": [
1
],
"travelMode": "van",
"vehicleCapacity": 12,
"routeStartTime": "08:00",
"routeStartLat": 37.7749,
"routeStartLng": -122.4194,
"workingHours": {
"monday": {
"start": 800,
"end": 1700
},
"tuesday": {
"start": 800,
"end": 1700
},
"wednesday": {
"start": 800,
"end": 1700
},
"thursday": {
"start": 800,
"end": 1700
},
"friday": {
"start": 800,
"end": 1700
},
"saturday": {
"start": 0,
"end": 0
},
"sunday": {
"start": 0,
"end": 0
}
}
}
'import requests
url = "https://api.hellotracks.com/v1/members"
payload = {
"username": "alex@example.com",
"name": "Alex Rivera",
"phone": "+1 415 555 0101",
"role": "worker",
"teams": [1],
"travelMode": "van",
"vehicleCapacity": 12,
"routeStartTime": "08:00",
"routeStartLat": 37.7749,
"routeStartLng": -122.4194,
"workingHours": {
"monday": {
"start": 800,
"end": 1700
},
"tuesday": {
"start": 800,
"end": 1700
},
"wednesday": {
"start": 800,
"end": 1700
},
"thursday": {
"start": 800,
"end": 1700
},
"friday": {
"start": 800,
"end": 1700
},
"saturday": {
"start": 0,
"end": 0
},
"sunday": {
"start": 0,
"end": 0
}
}
}
headers = {
"API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
username: 'alex@example.com',
name: 'Alex Rivera',
phone: '+1 415 555 0101',
role: 'worker',
teams: [1],
travelMode: 'van',
vehicleCapacity: 12,
routeStartTime: '08:00',
routeStartLat: 37.7749,
routeStartLng: -122.4194,
workingHours: {
monday: {start: 800, end: 1700},
tuesday: {start: 800, end: 1700},
wednesday: {start: 800, end: 1700},
thursday: {start: 800, end: 1700},
friday: {start: 800, end: 1700},
saturday: {start: 0, end: 0},
sunday: {start: 0, end: 0}
}
})
};
fetch('https://api.hellotracks.com/v1/members', 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/members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'username' => 'alex@example.com',
'name' => 'Alex Rivera',
'phone' => '+1 415 555 0101',
'role' => 'worker',
'teams' => [
1
],
'travelMode' => 'van',
'vehicleCapacity' => 12,
'routeStartTime' => '08:00',
'routeStartLat' => 37.7749,
'routeStartLng' => -122.4194,
'workingHours' => [
'monday' => [
'start' => 800,
'end' => 1700
],
'tuesday' => [
'start' => 800,
'end' => 1700
],
'wednesday' => [
'start' => 800,
'end' => 1700
],
'thursday' => [
'start' => 800,
'end' => 1700
],
'friday' => [
'start' => 800,
'end' => 1700
],
'saturday' => [
'start' => 0,
'end' => 0
],
'sunday' => [
'start' => 0,
'end' => 0
]
]
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hellotracks.com/v1/members"
payload := strings.NewReader("{\n \"username\": \"alex@example.com\",\n \"name\": \"Alex Rivera\",\n \"phone\": \"+1 415 555 0101\",\n \"role\": \"worker\",\n \"teams\": [\n 1\n ],\n \"travelMode\": \"van\",\n \"vehicleCapacity\": 12,\n \"routeStartTime\": \"08:00\",\n \"routeStartLat\": 37.7749,\n \"routeStartLng\": -122.4194,\n \"workingHours\": {\n \"monday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"tuesday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"wednesday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"thursday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"friday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"saturday\": {\n \"start\": 0,\n \"end\": 0\n },\n \"sunday\": {\n \"start\": 0,\n \"end\": 0\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hellotracks.com/v1/members")
.header("API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"alex@example.com\",\n \"name\": \"Alex Rivera\",\n \"phone\": \"+1 415 555 0101\",\n \"role\": \"worker\",\n \"teams\": [\n 1\n ],\n \"travelMode\": \"van\",\n \"vehicleCapacity\": 12,\n \"routeStartTime\": \"08:00\",\n \"routeStartLat\": 37.7749,\n \"routeStartLng\": -122.4194,\n \"workingHours\": {\n \"monday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"tuesday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"wednesday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"thursday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"friday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"saturday\": {\n \"start\": 0,\n \"end\": 0\n },\n \"sunday\": {\n \"start\": 0,\n \"end\": 0\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hellotracks.com/v1/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"username\": \"alex@example.com\",\n \"name\": \"Alex Rivera\",\n \"phone\": \"+1 415 555 0101\",\n \"role\": \"worker\",\n \"teams\": [\n 1\n ],\n \"travelMode\": \"van\",\n \"vehicleCapacity\": 12,\n \"routeStartTime\": \"08:00\",\n \"routeStartLat\": 37.7749,\n \"routeStartLng\": -122.4194,\n \"workingHours\": {\n \"monday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"tuesday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"wednesday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"thursday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"friday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"saturday\": {\n \"start\": 0,\n \"end\": 0\n },\n \"sunday\": {\n \"start\": 0,\n \"end\": 0\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"member": {
"id": "a1b2c3",
"type": "person",
"username": "alex@example.com",
"name": "Alex Rivera",
"email": "alex@example.com",
"phone": "+1 415 555 0101",
"color": "#2f80ed",
"profileImageUrl": "",
"companyId": "c0c0c0",
"role": "worker",
"statusLabel": "",
"teams": [
1
],
"location": {
"lat": 37.7793,
"lng": -122.4193,
"ts": 1761980400000,
"head": 90,
"accuracy": 12,
"speed": 0
},
"units": {
"distance": "US",
"time": "12",
"date": "MM-dd-yyyy"
},
"locale": {
"language": "en",
"timezone": "America/Los_Angeles"
},
"routeStartLat": 37.7749,
"routeStartLng": -122.4194,
"routeEndLat": 37.7749,
"routeEndLng": -122.4194,
"travelMode": "car",
"vehicleCapacity": 0,
"routeStartTime": "08:00",
"workingHours": {
"monday": {
"start": 800,
"end": 1700
},
"tuesday": {
"start": 800,
"end": 1700
},
"wednesday": {
"start": 800,
"end": 1700
},
"thursday": {
"start": 800,
"end": 1700
},
"friday": {
"start": 800,
"end": 1700
},
"saturday": {
"start": 0,
"end": 0
},
"sunday": {
"start": 0,
"end": 0
},
"source": "individual"
},
"workingHoursOverrides": {
"20261224": {
"start": 800,
"end": 1200
}
},
"states": {
"moving": "halted",
"tracking_status": true,
"location_services": true,
"login_status": true,
"battery_save": false,
"off_trackrecording": false,
"ignoring_battery_optimization": true,
"off_gps_stationary": false,
"location_permission": true,
"background_location": true
},
"timestamps": {
"signal": 1761980400000,
"created": 1735689600000,
"login": 1761970000000,
"sync": 1761975000000,
"tracking": 1761970000000,
"suspended": 0,
"recovered": 0,
"invited": 1735689600000,
"reminded": 1735689600000
}
}
},
"error": null,
"meta": {
"path": "/v1/members",
"method": "POST"
}
}{
"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": "already_exists",
"message": "Username already exists."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "throttled",
"message": "Too many requests."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}Members
Add a member
Adds a person to the company and sends them an invitation by email (and by text message when a phone number is given). username and name are required. All other fields are applied too. Adding a username that belongs to a removed member of the same company brings that member back. Workers can’t add members; only admins and company keys may add admins. A company that isn’t paying yet can have at most 300 members (403). A taken username answers 409.
POST
/
members
Add a member
curl --request POST \
--url https://api.hellotracks.com/v1/members \
--header 'API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"username": "alex@example.com",
"name": "Alex Rivera",
"phone": "+1 415 555 0101",
"role": "worker",
"teams": [
1
],
"travelMode": "van",
"vehicleCapacity": 12,
"routeStartTime": "08:00",
"routeStartLat": 37.7749,
"routeStartLng": -122.4194,
"workingHours": {
"monday": {
"start": 800,
"end": 1700
},
"tuesday": {
"start": 800,
"end": 1700
},
"wednesday": {
"start": 800,
"end": 1700
},
"thursday": {
"start": 800,
"end": 1700
},
"friday": {
"start": 800,
"end": 1700
},
"saturday": {
"start": 0,
"end": 0
},
"sunday": {
"start": 0,
"end": 0
}
}
}
'import requests
url = "https://api.hellotracks.com/v1/members"
payload = {
"username": "alex@example.com",
"name": "Alex Rivera",
"phone": "+1 415 555 0101",
"role": "worker",
"teams": [1],
"travelMode": "van",
"vehicleCapacity": 12,
"routeStartTime": "08:00",
"routeStartLat": 37.7749,
"routeStartLng": -122.4194,
"workingHours": {
"monday": {
"start": 800,
"end": 1700
},
"tuesday": {
"start": 800,
"end": 1700
},
"wednesday": {
"start": 800,
"end": 1700
},
"thursday": {
"start": 800,
"end": 1700
},
"friday": {
"start": 800,
"end": 1700
},
"saturday": {
"start": 0,
"end": 0
},
"sunday": {
"start": 0,
"end": 0
}
}
}
headers = {
"API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
username: 'alex@example.com',
name: 'Alex Rivera',
phone: '+1 415 555 0101',
role: 'worker',
teams: [1],
travelMode: 'van',
vehicleCapacity: 12,
routeStartTime: '08:00',
routeStartLat: 37.7749,
routeStartLng: -122.4194,
workingHours: {
monday: {start: 800, end: 1700},
tuesday: {start: 800, end: 1700},
wednesday: {start: 800, end: 1700},
thursday: {start: 800, end: 1700},
friday: {start: 800, end: 1700},
saturday: {start: 0, end: 0},
sunday: {start: 0, end: 0}
}
})
};
fetch('https://api.hellotracks.com/v1/members', 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/members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'username' => 'alex@example.com',
'name' => 'Alex Rivera',
'phone' => '+1 415 555 0101',
'role' => 'worker',
'teams' => [
1
],
'travelMode' => 'van',
'vehicleCapacity' => 12,
'routeStartTime' => '08:00',
'routeStartLat' => 37.7749,
'routeStartLng' => -122.4194,
'workingHours' => [
'monday' => [
'start' => 800,
'end' => 1700
],
'tuesday' => [
'start' => 800,
'end' => 1700
],
'wednesday' => [
'start' => 800,
'end' => 1700
],
'thursday' => [
'start' => 800,
'end' => 1700
],
'friday' => [
'start' => 800,
'end' => 1700
],
'saturday' => [
'start' => 0,
'end' => 0
],
'sunday' => [
'start' => 0,
'end' => 0
]
]
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hellotracks.com/v1/members"
payload := strings.NewReader("{\n \"username\": \"alex@example.com\",\n \"name\": \"Alex Rivera\",\n \"phone\": \"+1 415 555 0101\",\n \"role\": \"worker\",\n \"teams\": [\n 1\n ],\n \"travelMode\": \"van\",\n \"vehicleCapacity\": 12,\n \"routeStartTime\": \"08:00\",\n \"routeStartLat\": 37.7749,\n \"routeStartLng\": -122.4194,\n \"workingHours\": {\n \"monday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"tuesday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"wednesday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"thursday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"friday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"saturday\": {\n \"start\": 0,\n \"end\": 0\n },\n \"sunday\": {\n \"start\": 0,\n \"end\": 0\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hellotracks.com/v1/members")
.header("API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"alex@example.com\",\n \"name\": \"Alex Rivera\",\n \"phone\": \"+1 415 555 0101\",\n \"role\": \"worker\",\n \"teams\": [\n 1\n ],\n \"travelMode\": \"van\",\n \"vehicleCapacity\": 12,\n \"routeStartTime\": \"08:00\",\n \"routeStartLat\": 37.7749,\n \"routeStartLng\": -122.4194,\n \"workingHours\": {\n \"monday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"tuesday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"wednesday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"thursday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"friday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"saturday\": {\n \"start\": 0,\n \"end\": 0\n },\n \"sunday\": {\n \"start\": 0,\n \"end\": 0\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hellotracks.com/v1/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"username\": \"alex@example.com\",\n \"name\": \"Alex Rivera\",\n \"phone\": \"+1 415 555 0101\",\n \"role\": \"worker\",\n \"teams\": [\n 1\n ],\n \"travelMode\": \"van\",\n \"vehicleCapacity\": 12,\n \"routeStartTime\": \"08:00\",\n \"routeStartLat\": 37.7749,\n \"routeStartLng\": -122.4194,\n \"workingHours\": {\n \"monday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"tuesday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"wednesday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"thursday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"friday\": {\n \"start\": 800,\n \"end\": 1700\n },\n \"saturday\": {\n \"start\": 0,\n \"end\": 0\n },\n \"sunday\": {\n \"start\": 0,\n \"end\": 0\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"member": {
"id": "a1b2c3",
"type": "person",
"username": "alex@example.com",
"name": "Alex Rivera",
"email": "alex@example.com",
"phone": "+1 415 555 0101",
"color": "#2f80ed",
"profileImageUrl": "",
"companyId": "c0c0c0",
"role": "worker",
"statusLabel": "",
"teams": [
1
],
"location": {
"lat": 37.7793,
"lng": -122.4193,
"ts": 1761980400000,
"head": 90,
"accuracy": 12,
"speed": 0
},
"units": {
"distance": "US",
"time": "12",
"date": "MM-dd-yyyy"
},
"locale": {
"language": "en",
"timezone": "America/Los_Angeles"
},
"routeStartLat": 37.7749,
"routeStartLng": -122.4194,
"routeEndLat": 37.7749,
"routeEndLng": -122.4194,
"travelMode": "car",
"vehicleCapacity": 0,
"routeStartTime": "08:00",
"workingHours": {
"monday": {
"start": 800,
"end": 1700
},
"tuesday": {
"start": 800,
"end": 1700
},
"wednesday": {
"start": 800,
"end": 1700
},
"thursday": {
"start": 800,
"end": 1700
},
"friday": {
"start": 800,
"end": 1700
},
"saturday": {
"start": 0,
"end": 0
},
"sunday": {
"start": 0,
"end": 0
},
"source": "individual"
},
"workingHoursOverrides": {
"20261224": {
"start": 800,
"end": 1200
}
},
"states": {
"moving": "halted",
"tracking_status": true,
"location_services": true,
"login_status": true,
"battery_save": false,
"off_trackrecording": false,
"ignoring_battery_optimization": true,
"off_gps_stationary": false,
"location_permission": true,
"background_location": true
},
"timestamps": {
"signal": 1761980400000,
"created": 1735689600000,
"login": 1761970000000,
"sync": 1761975000000,
"tracking": 1761970000000,
"suspended": 0,
"recovered": 0,
"invited": 1735689600000,
"reminded": 1735689600000
}
}
},
"error": null,
"meta": {
"path": "/v1/members",
"method": "POST"
}
}{
"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": "already_exists",
"message": "Username already exists."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "throttled",
"message": "Too many requests."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}Authorizations
Body
application/json
Fields for creating or changing a member. Unknown fields are refused with 400.