Get companies in organisation

Retrieve companies for an organisation node. Use recursive=true (default) to include all companies in the subtree, or recursive=false to get only companies directly assigned to this node. Supports filtering by company_id for access validation purposes. Supports pagination with page[number] and page[size] parameters.

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

Access validation: The OAC token's organisation_node must be an ancestor of (or equal to) the requested node.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

UUID of the organisation node

Query Params
filter[company_id]
array of uuids
length between 1 and 2

Filter by specific company_ids (useful for validating access to multiple companies in a single request)

filter[company_id]
integer
≥ 1
Defaults to 1

Page number for pagination (1-indexed)

integer
1 to 100
Defaults to 20

Number of items per page

boolean
Defaults to true

If true (default), returns all companies in the subtree (node + all descendants). If false, returns only companies directly assigned to this node.

Headers
string
required

oAuth authorization using Bearer

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json