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.

🔒 External clients call this endpoint with an OAC (Organisation Access Credentials — ⚠️ Beta) access token carrying the companies:read scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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
^(organisation_node|bank_account)(?:,(organisation_node|bank_account))*$

Comma-separated list of related resources to include

Headers
string
required

Signature is used to enforce security by signing request.
Related documentation can be found by clicking here

string
required

RFC2822 formatted date.

string
required
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

uuid v4. Required in Redirect mode.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Choose an example:
application/json