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

Get task custom fields

Retrieves all custom fields configured for tasks in the workspace.

What are custom fields? Custom fields allow you to capture structured, project-specific data beyond standard task fields. They help organize information systematically and make data more consistent, reports more meaningful, and processes easier to automate.

Common use cases:

  • Priority levels by customer group or contract type
  • Reference numbers from external systems
  • Technical parameters or version details
  • Checkboxes for internal approvals
  • Dropdowns for classifications, responsibilities, or error categories

What is returned: An array of custom field objects, each containing:

  • Field identification (ID, name, description)
  • Field type (Text, TextArea, Number, Date, Checkbox, Select, MultiSelect)
  • Sort order for display
  • Multilingual translations for field name and description
  • Select options (for Select and MultiSelect types) with their own translations

Note: Custom fields are assigned to specific task types and appear in the task form when creating or editing tasks of those types.

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

Task custom fields retrieved successfully

Array of TaskCustomFieldResponseDto
descriptionobject | nullrequired

Default custom field description (used as fallback when no translation exists for user's language)

entitystringrequired

Entity type (always Task for task custom fields)

Allowed:TaskProjectOrganizationObject
idstringrequired

Custom field ID

namestringrequired

Default custom field name (used as fallback when no translation exists for user's language)

selectOptionsFieldOptionDto[]required

Select options with their translations. Each option has a default value and language-specific overrides.

Show properties
Array of FieldOptionDto
idobject

Option ID

translationsCustomFieldTranslationDto[]required

Language-specific translations for this option. Overrides the default value when user's language matches.

Show properties
Array of CustomFieldTranslationDto
languagestringrequired

Language code following ISO 639-1 format (e.g., "en", "de", "fr")

namestringrequired

Translated name for this language. Overrides the default name when user's language matches.

valuestringrequired

Default option value (used as fallback when no translation exists for user's language)

sortnumberrequired

Sort order

translationsCustomFieldTranslationDto[]required

Language-specific translations for field name. Overrides the default name when user's language matches.

Show properties
Array of CustomFieldTranslationDto
languagestringrequired

Language code following ISO 639-1 format (e.g., "en", "de", "fr")

namestringrequired

Translated name for this language. Overrides the default name when user's language matches.

typestringrequired

Custom field type

Allowed:TextTextareaNumberDateCheckboxSelectMultiSelectCurrencyUrl
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/custom-fields" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
[
  {
    "description": "Task priority level",
    "entity": "Task",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Priority",
    "selectOptions": [
      {
        "id": "1",
        "translations": [
          {
            "language": "en",
            "name": "Priority"
          }
        ],
        "value": "High"
      }
    ],
    "sort": 1,
    "translations": [
      {
        "language": "en",
        "name": "Priority"
      }
    ],
    "type": "Select"
  }
]