GET Paginated (treePaginated)

Developing

GET

/api/departments/tree/paginated

Get the hierarchical tree structure with pagination support. Paginates at the department level — each returned department includes its teams and users (limited by repository defaults). Falls back to org chart nodes when Department records don't exist.

Uses DepartmentService::getHierarchicalTreePaginated(). Organization-scoped: filters users by current tenant.

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api-dev.commandroom.ai/api/api/departments/tree/paginated?org_chart_id=15&page=1&per_page=10&include_users=true' \
--header 'Authorization: Bearer {{token}}' \
--header 'X-Tenant-UUID: '

Response Example

200 - OK

{
  "success": true,
  "data": [
    {
      "id": 1,
      "type": "department",
      "name": "Sample Name",
      "description": "Sample description text.",
      "original_id": 1,
      "teams_count": 10,
      "users_count": 10,
      "pagination": {
        "teams": {
          "loaded": 1,
          "total": 10,
          "has_more": true,
          "per_page": 1,
          "current_page": 1
        }
      },
      "children": [
        {}
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 1,
    "total": 10,
    "last_page": 1,
    "has_more": true
  }
}

Modified at 2026-07-02 04:47:16

GET Tree (tree)

GET Item (show)