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-fieldsAuthorization
AuthorizationOAuth2 access token · headerrequiredScopes:
api:reador
AuthorizationBearer token (JWT) · headerrequiredResponses
200Task custom fields retrieved successfully
Array of
TaskCustomFieldResponseDtodescriptionobject | nullrequiredDefault custom field description (used as fallback when no translation exists for user's language)
entitystringrequiredEntity type (always Task for task custom fields)
Allowed:
TaskProjectOrganizationObjectidstringrequiredCustom field ID
namestringrequiredDefault custom field name (used as fallback when no translation exists for user's language)
selectOptionsFieldOptionDto[]requiredSelect options with their translations. Each option has a default value and language-specific overrides.
Show propertiesHide properties
Array of
FieldOptionDtoidobjectOption ID
translationsCustomFieldTranslationDto[]requiredLanguage-specific translations for this option. Overrides the default value when user's language matches.
Show propertiesHide properties
Array of
CustomFieldTranslationDtolanguagestringrequiredLanguage code following ISO 639-1 format (e.g., "en", "de", "fr")
namestringrequiredTranslated name for this language. Overrides the default name when user's language matches.
valuestringrequiredDefault option value (used as fallback when no translation exists for user's language)
sortnumberrequiredSort order
translationsCustomFieldTranslationDto[]requiredLanguage-specific translations for field name. Overrides the default name when user's language matches.
Show propertiesHide properties
Array of
CustomFieldTranslationDtolanguagestringrequiredLanguage code following ISO 639-1 format (e.g., "en", "de", "fr")
namestringrequiredTranslated name for this language. Overrides the default name when user's language matches.
typestringrequiredCustom field type
Allowed:
TextTextareaNumberDateCheckboxSelectMultiSelectCurrencyUrl401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X GET "https://leadtime.app/api/public/administration/task-settings/custom-fields" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"const response = await fetch("https://leadtime.app/api/public/administration/task-settings/custom-fields", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
});import requests
response = requests.get(
"https://leadtime.app/api/public/administration/task-settings/custom-fields",
headers={
"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"
}
]Unauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions