Skip to content

GET /task-type

Get Task Types

GET
/task-type

List task types, optionally filtered by active status and name.

Returns TaskTypeFull records (includes associated print templates).
Pass active_only=false to include archived task types. name is a
substring match against the type name field.

Emits: (direct transaction — no event class)

Required scope: collaboration:task-type:read

Authorizations

OAuth2PasswordBearer
password Flow
Token URL"/api/auth"
Scopes:
  • "admin"User can access and edit users and system settings
  • "library"User can access and edit products
  • "production"User can access and edit production plans
  • "operator"User can access the operator panel and make production declarations

Parameters

Query Parameters

active_only
Type
boolean
Default
true
name

Responses

Successful Response

application/json
JSON
[
  
{
  
  
"_id": "string",
  
  
"_key": "string",
  
  
"_rev": "string",
  
  
"name": "Quality Inspection",
  
  
"description": "Covers all quality checks mandated by the production process.",
  
  
"active": true,
  
  
"icon": "check_circle",
  
  
"created": "2026-05-01T08:00:00Z",
  
  
"form_fields": [
  
  
  
{
  
  
  
  
"_key": "ffd-001",
  
  
  
  
"custom_field_key": "cf-001",
  
  
  
  
"multiple": false,
  
  
  
  
"label": "Colour Code",
  
  
  
  
"hint": "Verify against approved colour chart",
  
  
  
  
"default": "pass",
  
  
  
  
"mandatory": false,
  
  
  
  
"hidden": false
  
  
  
}
  
  
],
  
  
"link_settings": [
  
  
  
{
  
  
  
  
"type": "issue",
  
  
  
  
"enabled": true,
  
  
  
  
"allow_multiple": false,
  
  
  
  
"required": false
  
  
  
}
  
  
],
  
  
"require_time_entry": false,
  
  
"print_templates": [
  
  
  
{
  
  
  
  
"_id": "string",
  
  
  
  
"_key": "string",
  
  
  
  
"_rev": "string",
  
  
  
  
"name": "Serial Label A6",
  
  
  
  
"description": "A6 label for finished goods with QR code and serial number",
  
  
  
  
"template": {
  
  
  
  
  
"basePdf": "string",
  
  
  
  
  
"sampledata": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"schemas": [
  
  
  
  
  
  
[
  
  
  
  
  
  
]
  
  
  
  
  
],
  
  
  
  
  
"pdfmeVersion": "5.5.0"
  
  
  
  
},
  
  
  
  
"entities": 3
  
  
  
}
  
  
]
  
}
]

Samples

Powered by VitePress OpenAPI

Released under the Apache 2.0 License.