Get organization tree by ID

Retrieves a tree of organizations connected by parent ID by starting from the organization ID.

GET/api/v1/{team_slug}/{app_slug}/organisations/{org_id}/tree
API
Management
Updated
Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/organisations/{org_id}/tree

Retrieves a tree of organizations connected by parent ID by starting from the organization ID.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

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

Operation

  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}/tree
  • Summary: Get organization tree by ID
  • Description: Retrieves a tree of organizations connected by parent ID by starting from the organization ID.
  • OpenAPI contract: management-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.

Parameters3 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
org_idpathYesstringOrganization ID
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses5 statuses
StatusDescriptionContent
200Organization detailsapplication/json (object)
400Invalid request (e.g. bad organization ID format)application/json (object)
401Unauthorized accessapplication/json (object)
404Organization not foundapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Organisation Tree Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Organisation Tree
PropertyTypeRequiredDetails
app_idstringNo-
childrenobject[]No-
commentstringNo-
contact_namestringNo-
created_atstringNo-
credit_checkbooleanNo-
custom_fieldsobjectNo-
emailstringNo-
external_refstringNo-
idstringNo-
invoice_emailstringNo-
namestringNo-
organisation_numberstringNo-
parent_idstringNo-
phonestringNo-
statusstringNo-
tax_id_vat_numberstringNo-
updated_atstringNo-
{
  "data": {
    "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"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

404 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

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: Management API
  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}/tree
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Organizations
  • OpenAPI summary: Get organization tree by ID

Get organization tree by ID

# Get organization tree by ID Retrieves a tree of organizations connected by parent ID by starting from the organization ID.
GET /api/v1/{team_slug}/{app_slug}/organisations/{org_id}/tree
Purpose

Retrieves a tree of organizations connected by parent ID by starting from the organization ID.

Required inputs

app_slug path team_slug path org_id path

Primary response

200 ยท Organization details

Operation key

management-api:GET:/api/v1/{team_slug}/{app_slug}/organisations/{org_id}/tree

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/organisations/{org_id}/tree` - Summary: Get organization tree by ID - Description: Retrieves a tree of organizations connected by parent ID by starting from the organization ID. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/organisations/{org_id}/tree` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | org_id | path | Yes | string | Organization ID | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Organization details | application/json (object) | | 400 | Invalid request (e.g. bad organization ID format) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 404 | Organization not found | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Organisation Tree Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | 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 | - |
Generated example (synthetic) ```json { "data": { "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" }, "details": [ "string" ], "success": false } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "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):** ```json { "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):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/organisations/{org_id}/tree` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/organisations/{org_id}/tree` - OpenAPI tag: Organizations - OpenAPI summary: Get organization tree by ID