Finish a sign-up
curl --request POST \
--url https://api.hellotracks.com/v1/signup/verify \
--header 'API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "alex@example.com",
"code": "482913",
"company": {
"name": "Bay Plumbing Co.",
"address": "1 Market St, San Francisco, CA 94105"
},
"keyLabel": "laptop"
}
'import requests
url = "https://api.hellotracks.com/v1/signup/verify"
payload = {
"email": "alex@example.com",
"code": "482913",
"company": {
"name": "Bay Plumbing Co.",
"address": "1 Market St, San Francisco, CA 94105"
},
"keyLabel": "laptop"
}
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({
email: 'alex@example.com',
code: '482913',
company: {name: 'Bay Plumbing Co.', address: '1 Market St, San Francisco, CA 94105'},
keyLabel: 'laptop'
})
};
fetch('https://api.hellotracks.com/v1/signup/verify', 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/signup/verify",
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([
'email' => 'alex@example.com',
'code' => '482913',
'company' => [
'name' => 'Bay Plumbing Co.',
'address' => '1 Market St, San Francisco, CA 94105'
],
'keyLabel' => 'laptop'
]),
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/signup/verify"
payload := strings.NewReader("{\n \"email\": \"alex@example.com\",\n \"code\": \"482913\",\n \"company\": {\n \"name\": \"Bay Plumbing Co.\",\n \"address\": \"1 Market St, San Francisco, CA 94105\"\n },\n \"keyLabel\": \"laptop\"\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/signup/verify")
.header("API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"alex@example.com\",\n \"code\": \"482913\",\n \"company\": {\n \"name\": \"Bay Plumbing Co.\",\n \"address\": \"1 Market St, San Francisco, CA 94105\"\n },\n \"keyLabel\": \"laptop\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hellotracks.com/v1/signup/verify")
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 \"email\": \"alex@example.com\",\n \"code\": \"482913\",\n \"company\": {\n \"name\": \"Bay Plumbing Co.\",\n \"address\": \"1 Market St, San Francisco, CA 94105\"\n },\n \"keyLabel\": \"laptop\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"apiKey": "k7x2m9qa.0f1e2d3c4b5a69788796a5b4c3d2e1f0",
"apiKeyExpiresAt": 1769756400000,
"accountId": "a1b2c3",
"username": "alex@example.com",
"companyId": "c0c0c0",
"companyName": "Bay Plumbing Co."
},
"error": null,
"meta": {
"path": "/v1/signup/verify",
"method": "POST"
}
}{
"data": null,
"error": {
"code": "invalid_request",
"message": "date must be YYYY-MM-DD"
},
"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"
}
}Sign-up and sign-in
Finish a sign-up
Checks the emailed code, creates the company and returns an API key valid for 90 days (source ht_cli). The company address is geocoded before the code is used, so a wrong address doesn’t use up a try. A wrong or expired code answers 400 and says how many tries are left. Limited to 30 code checks per IP address an hour (429). No API key needed.
POST
/
signup
/
verify
Finish a sign-up
curl --request POST \
--url https://api.hellotracks.com/v1/signup/verify \
--header 'API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "alex@example.com",
"code": "482913",
"company": {
"name": "Bay Plumbing Co.",
"address": "1 Market St, San Francisco, CA 94105"
},
"keyLabel": "laptop"
}
'import requests
url = "https://api.hellotracks.com/v1/signup/verify"
payload = {
"email": "alex@example.com",
"code": "482913",
"company": {
"name": "Bay Plumbing Co.",
"address": "1 Market St, San Francisco, CA 94105"
},
"keyLabel": "laptop"
}
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({
email: 'alex@example.com',
code: '482913',
company: {name: 'Bay Plumbing Co.', address: '1 Market St, San Francisco, CA 94105'},
keyLabel: 'laptop'
})
};
fetch('https://api.hellotracks.com/v1/signup/verify', 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/signup/verify",
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([
'email' => 'alex@example.com',
'code' => '482913',
'company' => [
'name' => 'Bay Plumbing Co.',
'address' => '1 Market St, San Francisco, CA 94105'
],
'keyLabel' => 'laptop'
]),
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/signup/verify"
payload := strings.NewReader("{\n \"email\": \"alex@example.com\",\n \"code\": \"482913\",\n \"company\": {\n \"name\": \"Bay Plumbing Co.\",\n \"address\": \"1 Market St, San Francisco, CA 94105\"\n },\n \"keyLabel\": \"laptop\"\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/signup/verify")
.header("API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"alex@example.com\",\n \"code\": \"482913\",\n \"company\": {\n \"name\": \"Bay Plumbing Co.\",\n \"address\": \"1 Market St, San Francisco, CA 94105\"\n },\n \"keyLabel\": \"laptop\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hellotracks.com/v1/signup/verify")
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 \"email\": \"alex@example.com\",\n \"code\": \"482913\",\n \"company\": {\n \"name\": \"Bay Plumbing Co.\",\n \"address\": \"1 Market St, San Francisco, CA 94105\"\n },\n \"keyLabel\": \"laptop\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"apiKey": "k7x2m9qa.0f1e2d3c4b5a69788796a5b4c3d2e1f0",
"apiKeyExpiresAt": 1769756400000,
"accountId": "a1b2c3",
"username": "alex@example.com",
"companyId": "c0c0c0",
"companyName": "Bay Plumbing Co."
},
"error": null,
"meta": {
"path": "/v1/signup/verify",
"method": "POST"
}
}{
"data": null,
"error": {
"code": "invalid_request",
"message": "date must be YYYY-MM-DD"
},
"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
Body
application/json