Skip to main content
GET
List companies (V2)

Overview

Returns companies in the caller’s accessible hierarchy. The token’s CompanyId 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 OKCompaniesPagedResultDto (extends PagedListResult<CompanyDto>) CompanyDto fields: The response envelope adds these locale fields alongside the standard pagination fields:

Example response

Error responses

Authorizations

Authorization
string
header
required

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.

Query Parameters

page
integer
default:1
pageSize
integer
default:50

Response

Successful response