Skip to content
Leadtime
English
Esc
↑↓navigate↵open⌘Jpreview

Get task types

Retrieves all task types configured for the workspace.

What are task types? Task types are the backbone of task organization in Leadtime. They define what kind of tickets exist in the system (e.g., Feature, Bug, Support Case) and structure how tasks are created, documented, and handled.

What a task type includes:

  • Icon and name: Recognizable symbol and name (e.g., “Server Crash”, “Feature Request”)
  • Base type: Feature (value-adding work) or Bug (bug fix, typically not billable)
  • Status options: Which statuses can be used in this task type workflow
  • Custom fields: Additional structured data fields beyond standard fields
  • Work activities: Which time tracking activities are allowed
  • Task template: Pre-filled description structure for new tasks
  • Required fields: Fields that must be filled when creating tasks of this type

Benefits:

  • Structure workflows with unified statuses and fields
  • Ensure complete data capture with required fields
  • Enable precise analysis and reporting
  • Customize for different departments or teams

What is returned: An array of task type objects, each containing:

  • Type identification (ID, name, icon, base type)
  • Sort order for display
  • Multilingual translations
  • Associated status IDs
  • Associated custom field IDs
  • Associated work activity IDs
  • Task template as HTML
  • Required field names

Note: Task templates are returned as HTML, converted from the internal IDoc format.

GET/administration/task-settings/types
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:read
or
AuthorizationBearer token (JWT) · headerrequired
Responses
200

Task types retrieved successfully

Array of TaskTypeResponseDto
customFieldsstring[]required

Array of custom field IDs that are available for this task type

iconstringrequired

Icon for the task type in format :icon_name: (e.g., :rocket:, :bug:, :star:)

idstringrequired

Unique identifier of the task type

namestringrequired

Name of the task type

requiredFieldsstring[]required

Array of required field names for this task type. This is contextual metadata for POST /tasks: fields listed here must be included even when the global create-task OpenAPI schema marks them optional. Common values include summary, estimatedTime, deadline, assignedToId, accountableId, and custom field names.

sortnumberrequired

Sort order of the task type

statusesstring[]required

Array of task status IDs that can be used with this task type

templateDocstringrequired

Template document content as HTML

translationsTaskTypeTranslationDto[]required

Translations for the task type

Show properties
Array of TaskTypeTranslationDto
languagestringrequired

Language code for the translation

namestringrequired

Translated name of the task type

typestringrequired

Type of the task type

Allowed:FeatureBug
401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it
Server
Authorization
Request
curl -X GET "https://leadtime.app/api/public/administration/task-settings/types" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
[
  {
    "customFields": [
      "field-1",
      "field-2"
    ],
    "icon": ":rocket:",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Feature",
    "requiredFields": [
      "title",
      "description",
      "summary",
      "estimatedTime"
    ],
    "sort": 1,
    "statuses": [
      "status-1",
      "status-2"
    ],
    "templateDoc": "<h1>Task Template</h1><p>This is a template for new tasks of this type.</p>",
    "translations": [
      {
        "language": "en",
        "name": "Feature"
      },
      {
        "language": "de",
        "name": "Funktion"
      }
    ],
    "type": "Feature"
  }
]