Skip to main content
GET
List companies (V2)

Overview

Returns the token’s company and its sub-companies, at every level. Sub-companies come first; the token’s own company (level 0) is listed last, so when there are more companies than pageSize it is on the last page. Cancelled companies, and the companies below them, are left out. Not every listed company can be used with other endpoints — see Token scoping.
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: 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 by the key's company and its action set; see Token scoping.

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