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-fields

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Responses

200

Task custom fields retrieved successfully

Array of TaskCustomFieldDto

descriptionobject

Optional description explaining what this custom field is used for and how to fill it out

entitystringrequired

Entity this field belongs to. For task custom fields, this is always Task.

Allowed:TaskProjectOrganizationObject

idstringrequired

Unique identifier (UUID) for the custom field

namestringrequired

Name of the custom field (e.g., Risk Level, Affected Component, SLA Level). Used as the field label in forms.

selectOptionsSelectOptionDto[]required

Array of select options for dropdown (Select) type fields. Each option has a value and multilingual translations. Only populated for Select type fields.

Show properties

Array of SelectOptionDto

translationsTranslationDto[]required

Option translations

Show properties

Array of TranslationDto

descriptionobject

Translated description

languagestringrequired

Language code (e.g., en, es, fr)

namestringrequired

Translated name

valuestringrequired

Option value

sortnumberrequired

Sort order for displaying custom fields in forms. Lower numbers appear first.

translationsTranslationDto[]required

Multilingual translations for the custom field name and description. Supports displaying field labels in different languages based on user preferences.

Show properties

Array of TranslationDto

descriptionobject

Translated description

languagestringrequired

Language code (e.g., en, es, fr)

namestringrequired

Translated name

typestringrequired

Type 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:TextTextareaNumberDateCheckboxSelectMultiSelectCurrencyUrl

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

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"
  }
]