List categories.

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

Recent Requests

TimeStatusUser Agent

Make a request to see history.

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

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.tasks.listCategories({});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "colour": "string",
      "sort_order": 0,
      "grading_scheme": "string",
      "pass_mark": "string",
      "letter_bands": [],
      "reminder_lead": [],
      "task_count": 0
    }
  ]
}