Get organisation tree

Get the tree of organisations that the requested organisation is part of

GET/api/v1/{app_id}/organisations/{id}/tree

API: Auth
OpenAPI: auth-api
Updated: Apr 26, 2026

auth-api:GET:/api/v1/{app_id}/organisations/{id}/tree

Get the tree of organisations that the requested organisation is part of

API ownership

API family: Auth API
Best for: Customer identity, session, token, cart, and wishlist flows.
Do not use from: Merchant admin data syncs or public catalog rendering.
Guide route: /apis/auth/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

Method: GET
Path: /api/v1/\{app_id\}/organisations/\{id\}/tree
Summary: Get organisation tree
Description: Get the tree of organisations that the requested organisation is part of
OpenAPI contract: auth-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters

Name	In	Required	Type	Description
app_id	path	Yes	string	UUID of the app
id	path	Yes	string	UUID of the organisation

Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses

Status	Description	Content
200	OK	application/json (object)
400	Invalid request	application/json (object)
404	Organisation not found	application/json (object)
500	Internal server error	application/json (object)

200 - object

Get Organisation Tree

Property	Type	Required	Details
`ancestors`	object[]	No	-
`company_tree`	object	No	-

Company Node

Property	Type	Required	Details
`app_id`	string	No	-
`comment`	string	No	-
`contact_name`	string	No	-
`created_at`	string	No	-
`credit_check`	boolean	No	-
`custom_fields`	object	No	-
`email`	string	No	-
`external_ref`	string	No	-
`id`	string	No	-
`invoice_email`	string	No	-
`name`	string	No	-
`organisation_number`	string	No	-
`parent_id`	string	No	-
`phone`	string	No	-
`status`	string	No	-
`tax_id_vat_number`	string	No	-
`updated_at`	string	No	-

Organisation Tree

Property	Type	Required	Details
`app_id`	string	No	-
`children`	object[]	No	-
`comment`	string	No	-
`contact_name`	string	No	-
`created_at`	string	No	-
`credit_check`	boolean	No	-
`custom_fields`	object	No	-
`email`	string	No	-
`external_ref`	string	No	-
`id`	string	No	-
`invoice_email`	string	No	-
`name`	string	No	-
`organisation_number`	string	No	-
`parent_id`	string	No	-
`phone`	string	No	-
`status`	string	No	-
`tax_id_vat_number`	string	No	-
`updated_at`	string	No	-

{
  "ancestors": [
    {
      "app_id": "string",
      "comment": "string",
      "contact_name": "string",
      "created_at": "string",
      "credit_check": false,
      "custom_fields": {},
      "email": "string",
      "external_ref": "string",
      "id": "string",
      "invoice_email": "string",
      "name": "string",
      "organisation_number": "string",
      "parent_id": "string",
      "phone": "string",
      "status": "string",
      "tax_id_vat_number": "string",
      "updated_at": "string"
    }
  ],
  "company_tree": {
    "app_id": "string",
    "children": [
      {
        "app_id": "string",
        "children": [],
        "comment": "string",
        "contact_name": "string",
        "created_at": "string",
        "credit_check": false,
        "custom_fields": {},
        "email": "string",
        "external_ref": "string",
        "id": "string",
        "invoice_email": "string",
        "name": "string",
        "organisation_number": "string",
        "parent_id": "string",
        "phone": "string",
        "status": "string",
        "tax_id_vat_number": "string",
        "updated_at": "string"
      }
    ],
    "comment": "string",
    "contact_name": "string",
    "created_at": "string",
    "credit_check": false,
    "custom_fields": {},
    "email": "string",
    "external_ref": "string",
    "id": "string",
    "invoice_email": "string",
    "name": "string",
    "organisation_number": "string",
    "parent_id": "string",
    "phone": "string",
    "status": "string",
    "tax_id_vat_number": "string",
    "updated_at": "string"
  }
}

400 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

404 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

API family: Auth API
Method: GET
Path: /api/v1/\{app_id\}/organisations/\{id\}/tree
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Organisations
OpenAPI summary: Get organisation tree