Skip to main content
POST
List Companies

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 OKCompaniesDto

Example response

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.