Skip to main content
POST
/
api
/
GetCompanies
Gets the list of companies under a user / API key.
curl --request POST \
  --url https://api.telemax.com.au/api/GetCompanies \
  --header 'Authorization: <authorization>'
[
  {
    "id": 123,
    "name": "Acme Corporation",
    "parentId": null,
    "showCommands": false
  },
  {
    "id": 124,
    "name": "Subsidiary Corp",
    "parentId": 123,
    "showCommands": true
  }
]

Headers

​
Content-Type
string

Standard and must keep as it is.

​
Authorization
string
required

Bearer your_token

Response

200 - application/json

Successful response with list of companies

​
id
integer

Unique identifier for the company

Example:

123

​
name
string

Company name

Example:

"Acme Corporation"

​
parentId
integer | null

ID of parent company, null if top-level

Example:

456

​
showCommands
boolean

Whether commands should be shown for this company

Example:

false