Task types

Tasks · 3 операції

GETList task types/api/task-typePOSTCreate task type/api/task-typePUTUpdate task type/api/task-type/{id}

GET

List task types

/api/task-type

Task types with their subtypes. Use the ids when creating or filtering tasks.

list_task_types

Параметри запиту · 2

namestringдовжина макс. 100

isArchivalbooleanOmitted: active only; true: archived only; all: everything (becomes undefined, no filter).за замовчуванням false

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

messagestringобовʼязковий—

dataobject4 поля

totalnumberобовʼязковий—

totalPagesnumberобовʼязковий—

currentPagenumberобовʼязковий—

taskTypesobject[]обовʼязковий10 полів

taskTypeIdnumberобовʼязковий—

namestringобовʼязковий—

iconstringобовʼязковий—

colorstringобовʼязковийможе бути null—

instructionstringобовʼязковийможе бути null—

isDefaultbooleanобовʼязковий—

ordernumberобовʼязковий—

isArchivalbooleanобовʼязковий—

updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

Помилки400401403429500

curl "https://your-school.rist.pro/api/task-type" \
  -H "Authorization: Bearer $RIST_API_KEY"

const response = await fetch("https://your-school.rist.pro/api/task-type", {
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
  },
});
const { data } = await response.json();

import os
import requests

response = requests.get(
    "https://your-school.rist.pro/api/task-type",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "total": 0,
    "totalPages": 0,
    "currentPage": 0,
    "taskTypes": [
      {
        "taskTypeId": 1,
        "name": "string",
        "icon": "string",
        "color": "string",
        "instruction": "string",
        "isDefault": false,
        "order": 0,
        "isArchival": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00"
      }
    ]
  }
}

POST

Create task type

/api/task-type

Add a task type (name, icon key as in lesson types, optional #RRGGBB color and an instruction shown on its tasks). isDefault makes it the type of new tasks instead of the current default.

create_task_type

Тіло запиту

application/json · object

namestringобовʼязковийдовжина 1–100

iconstringобовʼязковийKey from the icon catalog shared with lesson types.довжина макс. 50

colorstringобовʼязковийможе бути nullAny #RRGGBB color, not a palette name.довжина 7–7

instructionstringобовʼязковийможе бути nullHint for the manager, shown on the card of a task of this type.довжина макс. 2000

isDefaultbooleanType given to a new task; switched in a transaction so there is always exactly one.

Відповідь · 201

application/json

statusCodenumberобовʼязковийприклад 201

messagestringобовʼязковий—

dataobject10 полів

taskTypeIdnumberобовʼязковий—

namestringобовʼязковий—

iconstringобовʼязковий—

colorstringобовʼязковийможе бути null—

instructionstringобовʼязковийможе бути null—

isDefaultbooleanобовʼязковий—

ordernumberобовʼязковий—

isArchivalbooleanобовʼязковий—

updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

Помилки400401403429500

curl -X POST "https://your-school.rist.pro/api/task-type" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "icon": "string",
    "color": "string",
    "instruction": "string",
    "isDefault": false
  }'

const response = await fetch("https://your-school.rist.pro/api/task-type", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "icon": "string",
    "color": "string",
    "instruction": "string",
    "isDefault": false
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.post(
    "https://your-school.rist.pro/api/task-type",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "name": "string",
        "icon": "string",
        "color": "string",
        "instruction": "string",
        "isDefault": False
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 201

{
  "statusCode": 201,
  "message": "Operation completed successfully",
  "data": {
    "taskTypeId": 1,
    "name": "string",
    "icon": "string",
    "color": "string",
    "instruction": "string",
    "isDefault": false,
    "order": 0,
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}

PUT

Update task type

/api/task-type/{id}

Change a task type; name and icon are always required.

update_task_type

Параметри шляху · 1

idnumberобовʼязковий—

Тіло запиту

application/json · object

namestringобовʼязковийдовжина 1–100

iconstringобовʼязковийKey from the icon catalog shared with lesson types.довжина макс. 50

colorstringобовʼязковийможе бути nullAny #RRGGBB color, not a palette name.довжина 7–7

instructionstringобовʼязковийможе бути nullHint for the manager, shown on the card of a task of this type.довжина макс. 2000

isDefaultbooleanType given to a new task; switched in a transaction so there is always exactly one.

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

messagestringобовʼязковий—

dataobject10 полів

taskTypeIdnumberобовʼязковий—

namestringобовʼязковий—

iconstringобовʼязковий—

colorstringобовʼязковийможе бути null—

instructionstringобовʼязковийможе бути null—

isDefaultbooleanобовʼязковий—

ordernumberобовʼязковий—

isArchivalbooleanобовʼязковий—

updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

Помилки400401403429500

curl -X PUT "https://your-school.rist.pro/api/task-type/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "icon": "string",
    "color": "string",
    "instruction": "string",
    "isDefault": false
  }'

const response = await fetch("https://your-school.rist.pro/api/task-type/1", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "icon": "string",
    "color": "string",
    "instruction": "string",
    "isDefault": false
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.put(
    "https://your-school.rist.pro/api/task-type/1",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "name": "string",
        "icon": "string",
        "color": "string",
        "instruction": "string",
        "isDefault": False
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "taskTypeId": 1,
    "name": "string",
    "icon": "string",
    "color": "string",
    "instruction": "string",
    "isDefault": false,
    "order": 0,
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}