Get a company

Retrieve a company. Companies are entities managed through your organisation structure that can be associated with organisation nodes.

Related resources are only returned when requested via the include query param:

  • To fetch without related resources, omit the include parameter.
  • To include related resources, pass a comma-separated list (e.g. organisation_node,bank_account).

🔒 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…
Path Params
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 of the company

Query Params
string
^(organisation_node|bank_account)(?:,(organisation_node|bank_account))*$

Comma-separated list of relationships 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

uuid v4. Required in Redirect mode.

Responses

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