SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Tasks

List the fields that apply: the workspace-wide fields plus those of the category, if one is given

GEThttps://app.softsolz.uk/api/v1/services/tasks/field-defs

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Query Params

scopestring

task (values on the task) or assignment (values on each piece of work).

category_idinteger

Include the fields of this category.

Response

Response Body · array of objects

idstringField id, lower-case letters, numbers and underscores.
typestringKind of value the field holds.
labelstringName shown to people.
helpstringShort hint shown under the field.
requiredbooleanWhether a value must be given.
optionsarray of objectsChoices for select and multi_select fields.
minnumberLowest number, or shortest text length.
maxnumberHighest number, or longest text length.
currencystringThree-letter currency code for currency fields.
show_on_cardbooleanShow the value on board cards.
expressionstringFormula fields: the calculation, using other number, currency, percentage and date fields by id, + - * / ( ), min, max, round, days_between and if(condition, a, b).
result_typestringFormula fields: how the result is shown.
sourcestringLookup fields: which linked record to read from.
source_fieldstringLookup fields: the field of the linked record to show.
via_fieldstringLookup fields: the field on this task that holds the link to the contact or company.
logicobjectShow the field only when these conditions match: { match: all|any, rules: [{ field, operator, value }] }. A hidden field is never required.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/tasks/field-defs \
--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": "your-id",
"type": "text",
"label": "your-label",
"help": "your-help",
"required": true,
"options": [
{
"value": "your-value",
"label": "your-label"
}
],
"min": 1,
"max": 1,
"currency": "your-currency",
"show_on_card": true,
"expression": "your-expression",
"result_type": "number",
"source": "task",
"source_field": "your-source-field",
"via_field": "your-via-field",
"logic": {}
}
]
}