List fields for a form template

GET/administration/form-templates/{templateId}/fields

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

templateIdstringrequired

Responses

200

Array of FormTemplateFieldResponseDto

createdAtstring<date-time>required

descriptionstringrequired

helpTextobject | null

idstringrequired

keyobject | null

When set, this string is the valueKey for PATCH /tasks/{identifier}/form-instances/{formInstanceId} payloads; when null, use the field id instead.

labelstringrequired

placeholderobject | null

requiredbooleanrequired

selectOptionsobject[]required

Options for Select, MultiSelect, Radio

settingsobjectrequired

Type-specific settings JSON

sortnumberrequired

templateIdstringrequired

typestringrequired

Allowed:TextTextareaNumberDateCheckboxSelectMultiSelectCurrencyUrlSectionHeadingFileUploadSignatureRadio

updatedAtstring<date-time>required

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

Parameters

templateIdpath*

Request

curl -X GET "https://leadtime.app/api/public/administration/form-templates/string/fields" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/administration/form-templates/string/fields", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/administration/form-templates/string/fields",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

[
  {
    "createdAt": "2019-08-24T14:15:22Z",
    "description": "string",
    "helpText": {},
    "id": "string",
    "key": {},
    "label": "string",
    "placeholder": {},
    "required": true,
    "selectOptions": [
      {}
    ],
    "settings": {},
    "sort": 0,
    "templateId": "string",
    "type": "Text",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]