Zum Inhalt springen
Leadtime
Deutsch
Esc
navigateopen⌘Jpreview

Get component tree for a specific project

Returns the complete hierarchical tree structure of components and their items for a specific project. Only non-deleted components and items are included in the response.

Component Tree Structure: The project tree organizes work into a clear hierarchy:

  • Components: Top-level containers that group related work packages. Examples include “Website Development”, “CRM Onboarding”, or “E-commerce Setup”. Each component represents a major deliverable or project phase.
  • Items: Building blocks within components. Each item can be one of four types:
    • Epic: Major sections or phases that group related work packages around a common theme (e.g., “Technical Implementation”, “Design & Development”)
    • Work Package: Self-contained, clearly defined tasks that deliver tangible results (e.g., “Set up hosting”, “Design homepage layout”). Work packages can have timeframes, questions, todos, and test cases.
    • Todo List: Checklists of sub-steps or checkpoints perfect for recurring processes, quality control, or project preparation (e.g., “Kickoff Checklist”, “Quality Control”)
    • Test Suite: Formal acceptance tests for project results. Contains multiple test cases with steps and expected results (e.g., “Contact Form Tests”, “SEO Review”)

Nesting and Relationships: Items can be nested to any depth, allowing for complex project structures. Each Work Package can contain Questions (to capture customer requirements), Todos (checklist items that can be checked off), and Test Cases (individual test steps within a Test Suite).

Use Cases: This endpoint is ideal for displaying the complete project structure in a tree view, understanding project organization, and navigating the component hierarchy.

GET/projects/{projectId}/components/tree
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:read
or
AuthorizationBearer token (JWT) · headerrequired
Path parameters
projectIdstringrequired
Responses
200Project component tree retrieved successfully
componentsComponentTreeComponentDto[]required
List of components in the library
Show properties
Array of ComponentTreeComponentDto
iconobject | nullrequired
Icon identifier for the component (nullable). Format: :icon_name: (e.g., :rocket:, :box:, :star:)
idstringrequired
Unique identifier for the component
namestringrequired
Name of the component
totalTimeFramenumberrequired
Total time frame for the component
itemsComponentTreeItemDto[]required
List of items (Epics, Work Packages, Todo Lists, Test Suites) in the library. Items are the building blocks within components and can be nested to any depth.
Show properties
Array of ComponentTreeItemDto
componentIdstringrequired
ID of the parent component
conditionsValidbooleanrequired
Whether all conditions are valid for this item
failedConditionsIdsstring[]required
Array of failed condition IDs
iconobject | nullrequired
Icon identifier for the component item (nullable). Format: :icon_name: (e.g., :rocket:, :check:, :star:)
idstringrequired
Unique identifier for the component item
namestringrequired
Name of the component item
parentIdobject | nullrequired
ID of the parent item (nullable for top-level items)
totalEstimatenumberrequired
Total time estimate for the item
typestringrequired
Type of the component item. Items are the building blocks within components: - **Epic**: Groups related work packages around a common theme - **WorkPackage**: Self-contained task that delivers a tangible result - **TodoList**: Checklist of sub-steps or checkpoints - **TestSuite**: Formal acceptance tests with test cases
Allowed:EpicWorkPackageTodoListTestSuite
400Invalid project ID format
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X GET "https://leadtime.app/api/public/projects/string/components/tree" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
{
  "components": [
    {
      "icon": ":box:",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "User Authentication Module",
      "totalTimeFrame": 40
    }
  ],
  "items": [
    {
      "componentId": "550e8400-e29b-41d4-a716-446655440000",
      "conditionsValid": true,
      "failedConditionsIds": [],
      "icon": ":check:",
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "name": "Login Feature",
      "parentId": null,
      "totalEstimate": 20,
      "type": "Epic"
    }
  ]
}