Recent Requests
Kept only in this browserTimeStatusTook
Send a request with Try it to see it here.
Headers
AuthorizationstringrequiredBearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.
Query Params
activestringSend 1 to list only active types.
Response
Response Body · array of objects
idintegerTask type id.namestringType name, up to 80 characters.descriptionstring | nullShort description.colourstringColour shown on cards.iconstringIcon shown on cards.number_prefixstring | nullLetters put before task numbers of this type, for example HK.default_category_idinteger | nullCategory given by default.default_prioritystring | nullPriority given by default.default_submission_modestring | nullHow work is handed in.checklistarray of objectsChecklist items new tasks of this type start with.task_fieldsarray | nullExtra fields on tasks of this type. Null uses the category or workspace fields.assignment_fieldsarray | nullExtra fields on work of this type.status_statesarray | nullStatuses for work of this type. Null uses the category or workspace set.assignment_defaultsobjectHow work of this type is given out by default.sort_orderintegerPosition in lists.is_activebooleanWhether new tasks can use this type.form_idinteger | nullA published form filled in on the work.form_rulesobjectWhat happens when the form fails a check.requires_signaturebooleanThe form needs a signature.is_restrictedbooleanOnly the people involved and the named viewers see tasks of this type.viewer_user_idsarray of integersMembers who may see restricted tasks of this type.is_deletedbooleanTrue once the type was removed.task_countintegerTasks that use this type.updated_atstringWhen the type last changed.Request
curl --request GET \ --url https://app.softsolz.uk/api/v1/services/tasks/types \ --header 'Authorization: Bearer sk_live_your_key'Credentials
Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.
Response · 200
{ "data": [ { "id": 4, "name": "Inspection", "description": "your-description", "colour": "blue", "icon": "ListChecks", "number_prefix": "HK", "default_category_id": 1, "default_priority": "low", "default_submission_mode": "your-default-submission-mode", "checklist": [ {} ], "task_fields": [ {} ], "assignment_fields": [ {} ], "status_states": [ {} ], "assignment_defaults": { "mode": "independent", "requires_acceptance": true, "strategy": "all" }, "sort_order": 1, "is_active": true, "form_id": 1, "form_rules": {}, "requires_signature": true, "is_restricted": true, "viewer_user_ids": [ 1 ], "is_deleted": true, "task_count": 1, "updated_at": "2026-01-01T09:00:00.000Z" } ]}