List companies

Lists all companies in the accessible organisation subtree. Companies are entities managed through your organisation structure that can be associated with organisation nodes.

Related resources can be returned with the include query param.

🔒 This endpoint requires an OAC (Organisation Access Credentials — ⚠️ Beta) access token with the companies:read scope.

Query Params
string

Filter by node

string
enum

Filter by activation_status

Allowed:
string
length between 1 and 50

Filter by external_id

integer
Defaults to 1

The page number of the response.
Related documentation can be found by clicking here

integer
Defaults to 100

The number of results returned on a page.
Related documentation can be found by clicking here

string

Comma-separated list of related resources to include

Headers
string
required

oAuth authorization using Bearer

Responses

Language
URL
Response
Choose an example:
application/json