Skip to content
Leadtime
English
Esc
navigateopen⌘Jpreview

Create a new component library component

Creates a new library component (reusable workspace template) with name, description, icon, tags, and internal notes.

What are Library Components? Library components are workspace-wide reusable templates (projectId is null). They serve as blueprints that can be imported into projects to standardize recurring project types. Components connect requirements management, cost calculation, and execution in one unified workflow.

After Creating a Component: Once created, you can add items (Epics, Work Packages, Todo Lists, Test Suites) to define the component structure. You can also add questions to capture customer requirements, todos for checklists, and test cases for acceptance testing.

Component Placement: The component is automatically appended to the end of the library component list. You can reorder components later using the sort endpoint.

Content Format: Description and internal note fields accept HTML or Markdown input and are automatically converted to the internal IDoc format for storage. When retrieved, this content is converted back to HTML for easy consumption.

POST/administration/project-components/components
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:write
or
AuthorizationBearer token (JWT) · headerrequired
Query parameters
fieldsToReturnstring
Comma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.
responseShapestring
Advanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.
Allowed:compactfull
Header parameters
LT-Response-Shapestring
Advanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.
Allowed:full
Request body
requiredapplication/json
descriptionstringrequired
Description (HTML or Markdown)
iconobject | null
Icon identifier. Format: :icon_name: (e.g., :rocket:, :box:, :star:)
internalNotestring
Internal note (HTML or Markdown, optional)
namestringrequired
Component name
tagsstring[]
Tag UUIDs
Responses
201Component created successfully
idstring<uuid>
400Invalid request: missing required fields or invalid UUID format for tags
401Unauthorized - Invalid or missing authentication token
403Insufficient permissions to edit component library
422Editor content conversion errors
Request
curl -X POST "https://leadtime.app/api/public/administration/project-components/components" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "<p>This module handles user authentication and authorization.</p>",
  "icon": ":box:",
  "internalNote": "<p>Internal implementation notes.</p>",
  "name": "User Authentication Module",
  "tags": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}'
Response
{
  "id": "e57dc37b-7693-4d06-b49c-17084b773aff"
}