Get project component details

Returns full details of a component from a project component tree including all nested children and metadata.

What are Project Components? Project components are reusable project templates that standardize recurring project types. They connect requirements management, cost calculation, and execution in one unified workflow. Each component contains items (Epics, Work Packages, Todo Lists, Test Suites) that define the project structure.

Project Components vs Library Components:

Project Components (this endpoint): Belong to a specific project, contain live data (answers to questions, test case evaluations, todo completion status), and can be connected to tasks in the task management system.
Library Components: Workspace-wide reusable templates (projectId is null) that serve as blueprints. They can be imported into projects to create project component instances.

Response Format: All ProseMirror editor content (description, internalNote) is automatically converted to HTML format for easy consumption. The response includes the complete hierarchical structure with all nested items and their metadata.

Access Control: Only project components that belong to the specified project (component.projectId equals projectId) are accessible through this endpoint.

GET/projects/{projectId}/components/component-details/{id}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

projectIdstringrequired

Project UUID

idstringrequired

Component UUID

Responses

200

childrenComponentChildrenShortItemDto[]required

Array of direct children items

Show properties

Array of ComponentChildrenShortItemDto

childrenComponentChildrenShortItemDto[]required

Nested children items

Show properties

Array of ComponentChildrenShortItemDto

Circular reference to ComponentChildrenShortItemDto.

conditionsValidbooleanrequired

Whether all conditions are valid

entityUniqueIdstringrequired

Entity unique ID

iconstring | nullrequired

Icon identifier in the format :icon_name: (e.g., :rocket:, :check:, :star:). Can be null if no icon is set.

idstringrequired

Unique identifier

namestringrequired

Name of the item

questionsCountnumberrequired

Count of questions

taskIdstring | nullrequired

Task ID if linked to a task

taskShortNumbernumber | nullrequired

Task short number if linked to a task

testCasesCountnumberrequired

Count of test cases

todosCountnumberrequired

Count of todo items

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

descriptionstringrequired

Component description in HTML format

discountAmountnumberrequired

Discount amount applied to this component. 0 means no discount.

discountTypestringrequired

Type of discount: "Fixed" (fixed amount) or "Percentage" (percentage of total price)

Allowed:FixedPercentage

iconstring | nullrequired

Icon identifier (nullable)

idstringrequired

Unique identifier for the component

internalNotestringrequired

Internal note in HTML format

namestringrequired

Name of the component

projectIdstring | nullrequired

Project ID (null for library components)

tagsstring[]required

Array of tags

400

Invalid projectId or component id format

401

Unauthorized - Invalid or missing authentication token

403

Insufficient permissions or no access to project

404

Component not found or does not belong to the specified project

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

projectIdpath*Project UUIDidpath*Component UUID

Request

curl -X GET "https://leadtime.app/api/public/projects/a47dc37b-7693-4d06-b49c-17084b773aff/components/component-details/e57dc37b-7693-4d06-b49c-17084b773aff" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/projects/a47dc37b-7693-4d06-b49c-17084b773aff/components/component-details/e57dc37b-7693-4d06-b49c-17084b773aff", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/projects/a47dc37b-7693-4d06-b49c-17084b773aff/components/component-details/e57dc37b-7693-4d06-b49c-17084b773aff",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "children": [
    {
      "children": [
        {}
      ],
      "conditionsValid": true,
      "entityUniqueId": "unique-id-123",
      "icon": ":check:",
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "name": "Login Feature",
      "questionsCount": 2,
      "taskId": "550e8400-e29b-41d4-a716-446655440002",
      "taskShortNumber": 123,
      "testCasesCount": 3,
      "todosCount": 5,
      "type": "Epic"
    }
  ],
  "description": "<p>This module handles user authentication and authorization.</p>",
  "discountAmount": 10,
  "discountType": "Percentage",
  "icon": "faBox",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "internalNote": "<p>Internal implementation notes.</p>",
  "name": "User Authentication Module",
  "projectId": null,
  "tags": [
    "authentication",
    "security"
  ]
}