SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
tasks

List categories.

List categories.

GEThttps://app.softsolz.uk/api/v1/services/tasks/categories

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.

Response

Response Body · array of objects

idintegerCategory id.
namestringWhat this category is called.
colourstring | nullToken name used to tint the category.
sort_orderintegerDisplay order.
grading_schemestringDefault scheme for tasks in this category.
pass_marknumber | nullThreshold for pass_fail, as a percentage.
letter_bandsarray of objectsBands for the letter scheme: { label, min_percent }, highest first.
reminder_leadarray of stringsHow far ahead to remind, as a list. Overrides the workspace default.
task_countintegerTasks filed under this category.

Request

curl --request GET \
  --url https://app.softsolz.uk/api/v1/services/tasks/categories \
  --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": 7,
      "name": "Safety",
      "colour": "amber",
      "sort_order": 10,
      "grading_scheme": "pass_fail",
      "pass_mark": 50,
      "letter_bands": [
        {
          "label": "A",
          "min_percent": 90
        },
        {
          "label": "B",
          "min_percent": 80
        }
      ],
      "reminder_lead": [
        "24h",
        "1h"
      ],
      "task_count": 18
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  }
}