Skip to main content
POST
/
api
/
GetCompanies
List Companies
curl --request POST \
  --url https://api.telemax.com.au/api/GetCompanies \
  --header 'Authorization: Bearer <token>'
{
  "Companies": [
    {
      "id": 123,
      "name": "Acme Corporation",
      "parentId": null,
      "showCommands": false
    },
    {
      "id": 124,
      "name": "Subsidiary Corp",
      "parentId": 123,
      "showCommands": true
    }
  ],
  "TimeZone": "SE Asia Standard Time",
  "UtcOffset": "00:07:00",
  "DateTimeFormat": "yyyy-MM-dd"
}

​
Overview

Returns the caller’s company hierarchy (including successors), with timezone, UTC offset string, and DateTimeFormat. Requires valid CompanyId claim.
A V2 version of this endpoint is available: List companies. New integrations should prefer V2.

​
Endpoint

POST /api/GetCompanies

​
Authentication

Required. Bearer token.

​
Response

200 OK — CompaniesDto
FieldTypeDescription
Companiesarray of CompanyDtoEach: Name, Id, ParentId, ShowCommands (always false here), Level, ApiKey (deprecated)
TimeZonestringIANA-style id from claims
UtcOffsetstringe.g. 10:00:00
DateTimeFormatstringUser date format pattern

​
Example response

{
  "Companies": [
    {
      "Name": "Acme Logistics",
      "Id": 12,
      "ParentId": null,
      "ShowCommands": false,
      "Level": 0,
      "ApiKey": ""
    }
  ],
  "TimeZone": "Australia/Sydney",
  "UtcOffset": "10:00:00",
  "DateTimeFormat": "dd/MM/yyyy"
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from POST /api/authentication/token/user or POST /api/authentication/token/api-key.

Lifetime: ~24 hours (86,399 seconds). Cache the token and reuse it. Re-authenticate 5 minutes before expiry.

Scoping:

  • User tokens are scoped to a single company.
  • API key tokens may restrict access to a vehicle allowlist and/or action set (see token claims).

No refresh endpoint — re-authenticate with your credentials when the token expires.

Headers

​
Content-Type
string

Standard and must keep as it is.

​
Authorization
string
required

Bearer your_token

Response

Successful response with list of companies

​
Companies
object[]
​
TimeZone
string

Current user's timezone

​
UtcOffset
string

Current user's UTC offset, based on the timezone.

Example:

"00:07:00"

​
DateTimeFormat
string

Current user's date-time format.