List all task custom fields
Returns a list of all custom fields configured for tasks in the workspace. Custom fields capture project-specific data and add structured, multilingual input fields to tasks beyond the standard fields. Available field types include Text, Text Area, Number, Date, Checkbox, and Select (dropdown). Each field includes translations, sort order, and select options for dropdown fields. This endpoint is optimized for common list data retrieval.
GET
/tasks/custom-fieldsAuthorization
AuthorizationOAuth2 access token · headerrequiredScopes:
api:reador
AuthorizationBearer token (JWT) · headerrequiredResponses
200Task custom fields retrieved successfully
Array of
TaskCustomFieldDtodescriptionobjectOptional description explaining what this custom field is used for and how to fill it out
entitystringrequiredEntity this field belongs to. For task custom fields, this is always Task.
Allowed:
TaskProjectOrganizationObjectidstringrequiredUnique identifier (UUID) for the custom field
namestringrequiredName of the custom field (e.g., Risk Level, Affected Component, SLA Level). Used as the field label in forms.
selectOptionsSelectOptionDto[]requiredArray of select options for dropdown (Select) type fields. Each option has a value and multilingual translations. Only populated for Select type fields.
Show propertiesHide properties
Array of
SelectOptionDtotranslationsTranslationDto[]requiredOption translations
Show propertiesHide properties
Array of
TranslationDtodescriptionobjectTranslated description
languagestringrequiredLanguage code (e.g., en, es, fr)
namestringrequiredTranslated name
valuestringrequiredOption value
sortnumberrequiredSort order for displaying custom fields in forms. Lower numbers appear first.
translationsTranslationDto[]requiredMultilingual translations for the custom field name and description. Supports displaying field labels in different languages based on user preferences.
Show propertiesHide properties
Array of
TranslationDtodescriptionobjectTranslated description
languagestringrequiredLanguage code (e.g., en, es, fr)
namestringrequiredTranslated name
typestringrequiredType of the custom field: Text (short entries), TextArea (longer entries), Number (numeric values), Date (date selection), Checkbox (Yes/No), or Select (dropdown with predefined options)
Allowed:
TextTextareaNumberDateCheckboxSelectMultiSelectCurrencyUrl401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X GET "https://leadtime.app/api/public/tasks/custom-fields" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"const response = await fetch("https://leadtime.app/api/public/tasks/custom-fields", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
});import requests
response = requests.get(
"https://leadtime.app/api/public/tasks/custom-fields",
headers={
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
},
)Response
[
{
"description": {},
"entity": "Task",
"id": "string",
"name": "string",
"selectOptions": [
{
"translations": [
{
"description": {},
"language": "string",
"name": "string"
}
],
"value": "string"
}
],
"sort": 0,
"translations": [
{
"description": {},
"language": "string",
"name": "string"
}
],
"type": "Text"
}
]Unauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions