Skip to content
Leadtime
English
Esc
navigateopen⌘Jpreview

List all form templates

Returns all form categories and form templates in the workspace. Form templates are reusable definitions that can be attached to tasks as form instances. Each template row includes metadata (name, category, tags, field count) but not individual field definitions. Use GET /workspace/form-templates/{id} to load the full field schema (types, labels, required flags, select options, settings) before attaching a template via POST /tasks/{identifier}/form-instances (body.templateId) or when building PATCH payloads: each values key matches the field key when set, otherwise the field id — the same strings appear as valueKey on GET /tasks/{identifier}/form-instances. Requires only the api scope (no FormTemplates.manage permission). For backward compatibility, GET /administration/form-templates-available returns the same list shape.

GET/workspace/form-templates
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:read
or
AuthorizationBearer token (JWT) · headerrequired
Responses
200Form categories and templates retrieved successfully
categoriesFormCategoryResponseDto[]required
Show properties
Array of FormCategoryResponseDto
defaultKeyobject | null
descriptionobject | null
iconstringrequired
idstringrequired
namestringrequired
sortnumberrequired
translationsFormCategoryTranslationResponseDto[]required
Show properties
Array of FormCategoryTranslationResponseDto
descriptionobject | null
languagestringrequired
nameobject | null
templatesFormTemplateListItemResponseDto[]required
Show properties
Array of FormTemplateListItemResponseDto
categoryobjectrequired
categoryIdstringrequired
createdAtstring<date-time>required
createdBystringrequired
descriptionstringrequired
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
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X GET "https://leadtime.app/api/public/workspace/form-templates" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
{
  "categories": [
    {
      "defaultKey": {},
      "description": {},
      "icon": "string",
      "id": "string",
      "name": "string",
      "sort": 0,
      "translations": [
        {
          "description": {},
          "language": "string",
          "name": {}
        }
      ]
    }
  ],
  "templates": [
    {
      "category": {},
      "categoryId": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "createdBy": "string",
      "description": "string",
      "fieldsCount": 0,
      "icon": {},
      "id": "string",
      "name": "string",
      "sort": 0,
      "tags": [
        "string"
      ],
      "updatedAt": "2024-01-01T00:00:00Z",
      "updatedBy": {}
    }
  ]
}