SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Tasks

The statuses that apply to a category (its own set, else the workspace set, else the default)

GEThttps://app.softsolz.uk/api/v1/services/tasks/status-sets/effective

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

category_idinteger

Use the statuses of this category. Leave out for the workspace statuses.

Response

Response Body

idinteger | nullSet id, null for the built-in set.
category_idinteger | nullCategory this set is for, null for the whole workspace.
namestringName of the set.
statesarray of objectsThe statuses in board order.
is_defaultbooleanTrue for the built-in set.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/tasks/status-sets/effective \
--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": 3,
"category_id": null,
"name": "Default",
"states": [
{
"key": "waiting_on_client",
"label": "Waiting on client",
"colour": "amber",
"description": "",
"category": "in_progress",
"allowed_next": null,
"wip_limit": 5,
"rules": {
"movers": {
"assignee": true,
"reviewer": true,
"roles": [
"manager"
],
"user_ids": [
31
]
},
"require_comment": false,
"require_fields": false,
"require_checklist": false,
"require_files": false
}
}
],
"is_default": false
}
}