Get project component overview
Returns the hierarchical structure of project components, items, and associated tasks.
What are Components? Components are reusable project templates that standardize recurring project types. They serve as blueprints for planning, pricing, and executing similar projects consistently. When imported into a project, components create a structured tree of work items.
Component Structure: Components contain a hierarchical tree of items:
- Epics: Groups related work packages around a common theme
- Work Packages: Self-contained, clearly defined tasks that deliver tangible results
- Todo Lists: Checklists for quality control and process steps
- Test Suites: Acceptance tests for formal approval
What is returned: The overview shows:
- Complete hierarchical structure of all components in the project
- All component items (Epics, Work Packages, Todo Lists, Test Suites)
- Tasks that have been connected to component items
- Implementation progress and status information
This endpoint helps track how project components are being implemented and which tasks are associated with each component item.
GET
/projects/{id}/component-overviewAuthorization
AuthorizationOAuth2 access token · headerrequiredScopes:
api:reador
AuthorizationBearer token (JWT) · headerrequiredPath parameters
idstringrequiredResponses
200Component overview retrieved successfully
401Unauthorized - Invalid or missing authentication token
403Forbidden - missing required permission
404Project not found
Request
curl -X GET "https://leadtime.app/api/public/projects/string/component-overview" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"const response = await fetch("https://leadtime.app/api/public/projects/string/component-overview", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
});import requests
response = requests.get(
"https://leadtime.app/api/public/projects/string/component-overview",
headers={
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
},
)Response
Component overview retrieved successfully
Unauthorized - Invalid or missing authentication token
Forbidden - missing required permission
Project not found