Get form template with fields

Returns one form template including all non-deleted fields in sort order. Each field includes type, label, optional key, id, required, placeholder, help text, type-specific settings JSON, and selectOptions for Select/MultiSelect/Radio. When calling PATCH /tasks/{identifier}/form-instances/{formInstanceId}, use property names in values equal to key when present, otherwise the field id (GET form instances exposes this as fields[].valueKey). Typical flow: GET this endpoint to plan values → POST attach with this template id → PATCH with those keys. Requires only the api scope (no FormTemplates.manage permission).

GET/workspace/form-templates/{id}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstring<uuid>required

Form template UUID

Responses

200

Form template with fields retrieved successfully

categoryobjectrequired

categoryIdstringrequired

createdAtstring<date-time>required

createdBystringrequired

descriptionstringrequired

fieldsFormTemplateFieldResponseDto[]required

Show properties

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

fieldsCountnumberrequired

Number of non-deleted fields on this template.

iconobject | null

idstringrequired

namestringrequired

sortnumberrequired

tagsstring[]required

Assigned form-template tag IDs (UUIDs).

updatedAtstring<date-time>required

updatedByobject | null

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

404

Form template not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

idpath*Form template UUID

Request

curl -X GET "https://leadtime.app/api/public/workspace/form-templates/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/workspace/form-templates/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/workspace/form-templates/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "category": {},
  "categoryId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "fields": [
    {
      "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"
    }
  ],
  "fieldsCount": 0,
  "icon": {},
  "id": "string",
  "name": "string",
  "sort": 0,
  "tags": [
    "string"
  ],
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": {}
}