Skip to content

Query Organization Tree ​

Endpoint Path ​

http
GET /api/open/organization/tree

Request Parameters ​

FieldTypeRequiredDescriptionConstraintsExample
enterprise_idintYesEnterprise IDQuery parameter; required1001

Request Example ​

json
GET 'https://neolink.com/backend/api/open/organization/tree?enterprise_id=1001'

Return Information ​

FieldTypeRequiredDescriptionRemarks
successboolYesRequest success indicatorFixed value
messagestringYesError message (empty if successful)Fixed value
data[]TreeNodeYesRoot nodes of organization treeTree structure; see table below

TreeNode Object (Recursive Structure)

FieldTypeRequiredDescriptionRemarks
idintYesOrganization IDDepartment identifier
namestringYesOrganization nameDepartment display name
enterprise_idintYesEnterprise IDEnterprise identifier
parent_idintYesParent organization ID0=first-level department
levelintYesOrganization level1=first-level; 2=second-level, etc
pathstringYesID pathFormat: "/2001/2002/2003"
tree_pathstringYesName pathFormat: "/Headquarters/R&D/Backend"
is_leafboolYesIs leaf nodetrue=no sub-departments
children[]TreeNodeNoSub-organizationsRecursive; empty if leaf

Response Example ​

json
{
  "success": true,
  "message": "",
  "data": [
    {
      "id": 2001,
      "name": "Headquarters",
      "enterprise_id": 1001,
      "parent_id": 0,
      "level": 1,
      "path": "/2001",
      "tree_path": "/Headquarters",
      "is_leaf": false,
      "children": [
        {
          "id": 2002,
          "name": "R&D",
          "enterprise_id": 1001,
          "parent_id": 2001,
          "level": 2,
          "path": "/2001/2002",
          "tree_path": "/Headquarters/R&D",
          "is_leaf": false,
          "children": []
        }
      ]
    }
  ]
}

Error responses:

json
{
  "success": false,
  "message": "Enterprise ID is empty"
}
{
  "success": false,
  "message": "Enterprise ID format error"
}
{
  "success": false,
  "message": "Insufficient permissions; only enterprise/department admins can view organization tree"
}
{
  "success": false,
  "message": "Enterprise is disabled; operation not allowed"
}