List companies (V2)
curl --request GET \
--url https://api.telemax.com.au/v2/api/companies \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.telemax.com.au/v2/api/companies"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.telemax.com.au/v2/api/companies', 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.telemax.com.au/v2/api/companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.telemax.com.au/v2/api/companies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.telemax.com.au/v2/api/companies")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.telemax.com.au/v2/api/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"dateTimeFormat": "dd/MM/yyyy",
"timezone": "Australia/Brisbane",
"utcOffset": "10:00:00",
"items": [
{
"id": 12,
"name": "Acme Fleet",
"parentId": null,
"showCommands": false,
"level": 0,
"apiKey": null
},
{
"id": 34,
"name": "Acme Sydney",
"parentId": 12,
"showCommands": false,
"level": 1,
"apiKey": null
}
],
"totalResults": 2,
"lastResultIndex": 2,
"currentPage": 1,
"numberOfPages": 1
}{
"type": "AUTHENTICATION",
"code": "INVALID_CREDENTIALS",
"description": "The provided API key is invalid or does not exist.",
"requestId": "0HNLTALNU4DCO:00000004",
"docUrl": "https://docs.telemax.com.au/errors/invalid-credentials"
}{
"type": "AUTHORIZATION",
"code": "INVALID_SCOPE",
"description": "The provided token does not have permission to access this resource.",
"requestId": "50e5c5f7-ccae-4ab6-b070-56d6645ceb1e",
"docUrl": "https://docs.telemax.com.au/errors/invalid-scope"
}{
"type": "RATE_LIMIT",
"code": "RATE_LIMIT_EXCEEDED",
"description": "Too many requests. Please slow down.",
"requestId": "req_6d2f8b4a",
"docUrl": "https://docs.telemax.com.au/errors/rate-limit-exceeded"
}{
"type": "SERVER_ERROR",
"code": "INTERNAL_SERVER_ERROR",
"description": "An unexpected error occurred. Please try again later.",
"requestId": "req_1e5a3c7d",
"docUrl": "https://docs.telemax.com.au/errors/internal-server-error"
}Companies & fleet
List companies
Returns a paginated list of companies accessible to the authenticated token.
GET
/
v2
/
api
/
companies
List companies (V2)
curl --request GET \
--url https://api.telemax.com.au/v2/api/companies \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.telemax.com.au/v2/api/companies"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.telemax.com.au/v2/api/companies', 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.telemax.com.au/v2/api/companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.telemax.com.au/v2/api/companies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.telemax.com.au/v2/api/companies")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.telemax.com.au/v2/api/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"dateTimeFormat": "dd/MM/yyyy",
"timezone": "Australia/Brisbane",
"utcOffset": "10:00:00",
"items": [
{
"id": 12,
"name": "Acme Fleet",
"parentId": null,
"showCommands": false,
"level": 0,
"apiKey": null
},
{
"id": 34,
"name": "Acme Sydney",
"parentId": 12,
"showCommands": false,
"level": 1,
"apiKey": null
}
],
"totalResults": 2,
"lastResultIndex": 2,
"currentPage": 1,
"numberOfPages": 1
}{
"type": "AUTHENTICATION",
"code": "INVALID_CREDENTIALS",
"description": "The provided API key is invalid or does not exist.",
"requestId": "0HNLTALNU4DCO:00000004",
"docUrl": "https://docs.telemax.com.au/errors/invalid-credentials"
}{
"type": "AUTHORIZATION",
"code": "INVALID_SCOPE",
"description": "The provided token does not have permission to access this resource.",
"requestId": "50e5c5f7-ccae-4ab6-b070-56d6645ceb1e",
"docUrl": "https://docs.telemax.com.au/errors/invalid-scope"
}{
"type": "RATE_LIMIT",
"code": "RATE_LIMIT_EXCEEDED",
"description": "Too many requests. Please slow down.",
"requestId": "req_6d2f8b4a",
"docUrl": "https://docs.telemax.com.au/errors/rate-limit-exceeded"
}{
"type": "SERVER_ERROR",
"code": "INTERNAL_SERVER_ERROR",
"description": "An unexpected error occurred. Please try again later.",
"requestId": "req_1e5a3c7d",
"docUrl": "https://docs.telemax.com.au/errors/internal-server-error"
}Overview
Returns companies in the caller’s accessible hierarchy. The token’sCompanyId claim is the root; sub-companies are included where the caller has access.
This endpoint replaces V1 Company tree.
Rate limit: 4 req/s · 30/min · 600/hr · 14,400/day
Endpoint
GET /v2/api/companies
Query parameters
integer
default:"1"
Page number (1-based).
integer
default:"50"
Records per page.
Response
200 OK —CompaniesPagedResultDto (extends PagedListResult<CompanyDto>)
CompanyDto fields:
| Field | Type | Description |
|---|---|---|
| id | integer | Company ID |
| name | string | Company display name |
| parentId | integer | null | Parent company ID (null for root) |
| showCommands | boolean | Whether command actions are shown for this company |
| level | integer | Company hierarchy depth (0 = root) |
| apiKey | string | null | Company API key. null if no API key is configured for this company |
| Field | Type | Description |
|---|---|---|
| dateTimeFormat | string | Authenticated user’s preferred date/time format (e.g. "dd/MM/yyyy HH:mm") |
| timezone | string | Authenticated user’s IANA timezone identifier (e.g. "Australia/Brisbane") |
| utcOffset | string | UTC offset for the user’s timezone at request time. Positive offsets have no sign prefix (e.g. "10:00:00"); negative offsets include - (e.g. "-05:00:00") |
Example response
{
"items": [
{ "id": 12, "name": "Acme Fleet", "parentId": null, "showCommands": false, "level": 0, "apiKey": null },
{ "id": 34, "name": "Acme Sydney", "parentId": 12, "showCommands": false, "level": 1, "apiKey": null }
],
"currentPage": 1,
"numberOfPages": 1,
"totalResults": 2,
"lastResultIndex": 1,
"dateTimeFormat": "dd/MM/yyyy",
"timezone": "Australia/Brisbane",
"utcOffset": "10:00:00"
}
Error responses
| Status | Meaning |
|---|---|
| 401 | Missing or invalid token |
curl "https://api.telemax.com.au/v2/api/companies" \
-H "Authorization: Bearer <token>"
Authorizations
JWT Bearer token obtained from POST /v2/api/authentication/token/api-key.
Lifetime: ~24 hours (86,399 seconds). Cache the token and reuse it. Re-authenticate 5 minutes before expiry.
Scoping: API key tokens are scoped to the company the key belongs to and may restrict access to a vehicle allowlist and/or action set (see token claims).
No refresh endpoint — re-authenticate with your API key when the token expires.
Response
Successful response
Was this page helpful?
⌘I