---
title: "Retrieve all descendants of a business entity"
method: GET
path: "/v1/organization/business_entities/{id}/descendants"
tags: ["Organization management"]
---

# Retrieve all descendants of a business entity

`GET /v1/organization/business_entities/{id}/descendants`

## Request

- Base URL: `https://api.sinai.com`
- URL: `https://api.sinai.com/v1/organization/business_entities/{id}/descendants`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://auth.sinai.com/oauth2/token` scopes: `https://api.sinai.com/organization`
  - OAuth 2
    - Authorization code: `https://auth.sinai.com/oauth2/authorize`
    - Token URL: `https://auth.sinai.com/oauth2/token`
- TypeScript: <https://skmtc.dev/sinai/apis/sinai-api/docs/v1/organization/business_entities/:id/descendants/get.ts> (a function with typed inputs; its response is checked against the schema)

Use this endpoint to get all the business entities that are descendants of the entity specified by the ID. Descendants include children of a business entities and also the children of those children.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `business_entity_type_id` string, uuid
- `business_entity_type_category` 'ORG_LEVEL' | 'MID_LEVEL' | 'FACILITY_LEVEL' | 'PROCESS_LEVEL'

## Response `200`

Business entity retrieved successfully

- BusinessEntity[]
  - `id` string, uuid, required
  - `orgID` string, uuid
  - `parentID` string, uuid, nullable
  - `name` string, required: The name of the business entity
  - `description` string: A description of the business entity
  - `countryCode` string: The country code of the business entity.
  - `subIndustryCode` string, nullable: The sub-industry code of the business entity or functional unit, formatted as eight digits.
  - `facilityTypeID` string, uuid, nullable: The facility type of the business entity if it is a facility.
  - `processTypeID` string, uuid, nullable: The process type of the business entity if it is a process.
  - `businessEntityTypeID` string, uuid
  - `defaultFunctionalUnitID` string, uuid
  - `defaultDisplayUnit` string: The default display unit for the functional unit of the business entity
  - `activeStartTimestamp` number: The timestamp when the business entity becomes active, in milliseconds since epoch
  - `activeEndTimestamp` number: The timestamp when the business entity becomes inactive, in milliseconds since epoch

## Other responses

- `403`: You are not authorized to acess this object
- `404`: Object not found

---

[API](https://skmtc.dev/sinai/apis/sinai-api.md) - [All operations](https://skmtc.dev/sinai/apis/sinai-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sinai/apis/sinai-api/revisions/495dab1b31fd?raw)