TasksTasks

Tasks

Tasks · 7 операцій

GET

List tasks

/api/task

Tasks with filters: deadlineBucket (OVERDUE, TODAY, TOMORROW, WEEK, LATER), deadline range, completed range (completedStart/completedEnd with isCompleted=true), type, assignee. For "my tasks" pass assigneeUserIds with the current user id (iAmResponsible means the manager of the linked student, not the assignee). Paginated; "total" is the full count.

list_tasks

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

pagenumberмін. 1 · за замовчуванням 1
pageSizenumber1–250 · за замовчуванням 20
sortBystringrelevance: open tasks by deadline (overdue first), then completed ones; used by card lists.Одне з: isCompleted deadline relevance
sortOrderstringОдне з: ASC DESC
taskIdsnumber[]—
deadlineBucketstringBoard column; its bounds are computed in the school time zone.Одне з: OVERDUE TODAY TOMORROW WEEK LATER
isCompletedboolean—
textOfTaskstring—
Показати ще 20
deadlineStartstringPeriod start, a school-local calendar day.
deadlineEndstringPeriod end, inclusive: the end of that school-local day.
completedStartstringCompleted from, a school-local calendar day; pair with isCompleted=true.
completedEndstringCompleted until, inclusive: the end of that school-local day.
resultOfTaskstring—
typeIdnumber—
subtypeIdnumber—
assigneeUserIdnumber—
assigneeUserIdsnumber[]—
managerIdsnumber[]Manager of the linked student or lead, not the task assignee.
iAmResponsiblebooleanTasks whose linked student or lead is managed by the current user (taken from the session).
studentIdnumber—
studentIdsnumber[]—
withLeadTasksbooleanAlso include tasks of the student's leads, created before conversion.
leadIdnumber—
leadIdsnumber[]—
groupIdnumber—
groupIdsnumber[]—
isArchivalobjectобовʼязковийза замовчуванням false
cfstring[]—

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject4 поля
totalnumberобовʼязковий—
totalPagesnumberобовʼязковий—
currentPagenumberобовʼязковий—
tasksobject[]обовʼязковий13 полів
taskIdnumberобовʼязковий—
textOfTaskstring—
isCompletedboolean—
completedAtstringможе бути nullформат YYYY-MM-DDTHH:mm:ss
deadlinestringSchool-local wall time; a point in time only when hasTime is true.формат YYYY-MM-DDTHH:mm:ss
hasTimeboolean—
resultOfTaskstringможе бути null—
notestringможе бути null—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
deadlineBucketstringBoard column, derived on read.Одне з: OVERDUE TODAY TOMORROW WEEK LATER
customFieldsobjectдовільні ключі
Помилки400401403429500
curl "https://your-school.rist.pro/api/task?isArchival=false" \
  -H "Authorization: Bearer $RIST_API_KEY"
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "total": 0,
    "totalPages": 0,
    "currentPage": 0,
    "tasks": [
      {
        "taskId": 1,
        "textOfTask": "string",
        "isCompleted": false,
        "completedAt": "2026-11-09T14:30:00",
        "deadline": "2026-11-09T14:30:00",
        "hasTime": false,
        "resultOfTask": "string",
        "note": "string",
        "isArchival": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00",
        "deadlineBucket": "OVERDUE",
        "customFields": {}
      }
    ]
  }
}
GET

How many tasks match the GET /api/task filters, per assignee, type or subtype (groupBy). E.g. overdue per manager: groupBy=assignee, deadlineBucket=OVERDUE. One call instead of paging through GET /api/task.

count_tasks

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

cfstring[]—
taskIdsnumber[]—
deadlineBucketstringBoard column; its bounds are computed in the school time zone.Одне з: OVERDUE TODAY TOMORROW WEEK LATER
isCompletedboolean—
textOfTaskstring—
deadlineStartstringPeriod start, a school-local calendar day.
deadlineEndstringPeriod end, inclusive: the end of that school-local day.
completedStartstringCompleted from, a school-local calendar day; pair with isCompleted=true.
Показати ще 17
completedEndstringCompleted until, inclusive: the end of that school-local day.
resultOfTaskstring—
typeIdnumber—
subtypeIdnumber—
assigneeUserIdnumber—
assigneeUserIdsnumber[]—
managerIdsnumber[]Manager of the linked student or lead, not the task assignee.
iAmResponsiblebooleanTasks whose linked student or lead is managed by the current user (taken from the session).
studentIdnumber—
studentIdsnumber[]—
withLeadTasksbooleanAlso include tasks of the student's leads, created before conversion.
leadIdnumber—
leadIdsnumber[]—
groupIdnumber—
groupIdsnumber[]—
isArchivalobjectобовʼязковийза замовчуванням false
groupBystringобовʼязковийWhat to count tasks byОдне з: assignee type subtype

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject3 поля
omittedRowsnumberRows left out by the limit
totalnumberобовʼязковийRecords matching the filters; a record counted in several rows (a student with two teachers) counts here once.
rowsobject[]обовʼязковий3 поля
idinteger | stringобовʼязковийможе бути nullId of the grouped value (teacher id, stage id, weekday 1-7) or its code (lesson status); null means "no value".
namestringобовʼязковий—
countnumberобовʼязковий—
Помилки400401403429500
curl "https://your-school.rist.pro/api/task/breakdown?isArchival=false&groupBy=assignee" \
  -H "Authorization: Bearer $RIST_API_KEY"
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "omittedRows": 0,
    "total": 0,
    "rows": [
      {
        "id": 1,
        "name": "string",
        "count": 0
      }
    ]
  }
}
GET

Get task

/api/task/{id}

One task with assignee, deadline and linked student, lead or group.

get_task

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

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

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject13 полів
taskIdnumberобовʼязковий—
textOfTaskstring—
isCompletedboolean—
completedAtstringможе бути nullформат YYYY-MM-DDTHH:mm:ss
deadlinestringSchool-local wall time; a point in time only when hasTime is true.формат YYYY-MM-DDTHH:mm:ss
hasTimeboolean—
resultOfTaskstringможе бути null—
notestringможе бути null—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
deadlineBucketstringBoard column, derived on read.Одне з: OVERDUE TODAY TOMORROW WEEK LATER
customFieldsobjectдовільні ключі
Помилки400401403429500
curl "https://your-school.rist.pro/api/task/1" \
  -H "Authorization: Bearer $RIST_API_KEY"
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "taskId": 1,
    "textOfTask": "string",
    "isCompleted": false,
    "completedAt": "2026-11-09T14:30:00",
    "deadline": "2026-11-09T14:30:00",
    "hasTime": false,
    "resultOfTask": "string",
    "note": "string",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00",
    "deadlineBucket": "OVERDUE",
    "customFields": {}
  }
}
POST

Create task

/api/task

Create a task for a staff member, optionally linked to a student, lead or group. Deadline is school local time.

create_task

Тіло запиту

application/json · object

textOfTaskstringобовʼязковийдовжина 1–3000
typeIdnumberTask type; defaults to the school's default type.мін. 1
subtypeIdnumberможе бути nullмін. 1
deadlinestringSchool-local wall time; defaults to the start of tomorrow. With hasTime false it means the whole day.
hasTimeboolean—
assigneeUserIdnumberDefaults to the task author.мін. 1
notestringможе бути nullдовжина макс. 1500
studentIdsnumber[]може бути nullмін. 1
leadIdsnumber[]може бути nullмін. 1
groupIdsnumber[]може бути nullмін. 1
customFieldsobjectдовільні ключі

Відповідь · 201

application/json

statusCodenumberобовʼязковийприклад 201
messagestringобовʼязковий—
dataobject13 полів
taskIdnumberобовʼязковий—
textOfTaskstring—
isCompletedboolean—
completedAtstringможе бути nullформат YYYY-MM-DDTHH:mm:ss
deadlinestringSchool-local wall time; a point in time only when hasTime is true.формат YYYY-MM-DDTHH:mm:ss
hasTimeboolean—
resultOfTaskstringможе бути null—
notestringможе бути null—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
deadlineBucketstringBoard column, derived on read.Одне з: OVERDUE TODAY TOMORROW WEEK LATER
customFieldsobjectдовільні ключі
Помилки400401403429500
curl -X POST "https://your-school.rist.pro/api/task" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "textOfTask": "string",
    "typeId": 1,
    "subtypeId": 1,
    "deadline": "string",
    "hasTime": false,
    "assigneeUserId": 1,
    "note": "string",
    "studentIds": [
      1
    ],
    "leadIds": [
      1
    ],
    "groupIds": [
      1
    ],
    "customFields": {}
  }'
Приклад відповіді · 201
{
  "statusCode": 201,
  "message": "Operation completed successfully",
  "data": {
    "taskId": 1,
    "textOfTask": "string",
    "isCompleted": false,
    "completedAt": "2026-11-09T14:30:00",
    "deadline": "2026-11-09T14:30:00",
    "hasTime": false,
    "resultOfTask": "string",
    "note": "string",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00",
    "deadlineBucket": "OVERDUE",
    "customFields": {}
  }
}
PATCH

Update task

/api/task/{id}

Change fields of a task. Send only the fields to change.

update_task

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

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

Тіло запиту

application/json · object

textOfTaskstringдовжина 1–3000
typeIdnumberTask type; defaults to the school's default type.мін. 1
subtypeIdnumberможе бути nullмін. 1
deadlinestringSchool-local wall time; defaults to the start of tomorrow. With hasTime false it means the whole day.
hasTimeboolean—
assigneeUserIdnumberDefaults to the task author.мін. 1
notestringможе бути nullдовжина макс. 1500
studentIdsnumber[]може бути nullмін. 1
leadIdsnumber[]може бути nullмін. 1
groupIdsnumber[]може бути nullмін. 1
customFieldsobjectдовільні ключі
resultOfTaskstringможе бути nullдовжина макс. 3000
deadlineBucketstringBoard column to move the task to; the server derives the deadline. Mutually exclusive with deadline.Одне з: OVERDUE TODAY TOMORROW WEEK LATER

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject13 полів
taskIdnumberобовʼязковий—
textOfTaskstring—
isCompletedboolean—
completedAtstringможе бути nullформат YYYY-MM-DDTHH:mm:ss
deadlinestringSchool-local wall time; a point in time only when hasTime is true.формат YYYY-MM-DDTHH:mm:ss
hasTimeboolean—
resultOfTaskstringможе бути null—
notestringможе бути null—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
deadlineBucketstringBoard column, derived on read.Одне з: OVERDUE TODAY TOMORROW WEEK LATER
customFieldsobjectдовільні ключі
Помилки400401403429500
curl -X PATCH "https://your-school.rist.pro/api/task/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "textOfTask": "string",
    "typeId": 1,
    "subtypeId": 1,
    "deadline": "string",
    "hasTime": false,
    "assigneeUserId": 1,
    "note": "string",
    "studentIds": [
      1
    ],
    "leadIds": [
      1
    ],
    "groupIds": [
      1
    ],
    "customFields": {},
    "resultOfTask": "string",
    "deadlineBucket": "OVERDUE"
  }'
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "taskId": 1,
    "textOfTask": "string",
    "isCompleted": false,
    "completedAt": "2026-11-09T14:30:00",
    "deadline": "2026-11-09T14:30:00",
    "hasTime": false,
    "resultOfTask": "string",
    "note": "string",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00",
    "deadlineBucket": "OVERDUE",
    "customFields": {}
  }
}
PATCH

Complete task

/api/task/complete/{id}

Mark a task as completed, optionally with a result (resultOfTask) and a follow-up task (next).

complete_task

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

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

Тіло запиту

application/json · object

resultOfTaskstringможе бути nullдовжина макс. 3000
nextobject11 полів
textOfTaskstringобовʼязковийдовжина 1–3000
typeIdnumberTask type; defaults to the school's default type.мін. 1
subtypeIdnumberможе бути nullмін. 1
deadlinestringSchool-local wall time; defaults to the start of tomorrow. With hasTime false it means the whole day.
hasTimeboolean—
assigneeUserIdnumberDefaults to the task author.мін. 1
notestringможе бути nullдовжина макс. 1500
studentIdsnumber[]може бути nullмін. 1
leadIdsnumber[]може бути nullмін. 1
groupIdsnumber[]може бути nullмін. 1
customFieldsobjectдовільні ключі

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject2 поля
completedobjectобовʼязковий13 полів
taskIdnumberобовʼязковий—
textOfTaskstring—
isCompletedboolean—
completedAtstringможе бути nullформат YYYY-MM-DDTHH:mm:ss
deadlinestringSchool-local wall time; a point in time only when hasTime is true.формат YYYY-MM-DDTHH:mm:ss
hasTimeboolean—
resultOfTaskstringможе бути null—
notestringможе бути null—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
deadlineBucketstringBoard column, derived on read.Одне з: OVERDUE TODAY TOMORROW WEEK LATER
customFieldsobjectдовільні ключі
nextobjectобовʼязковийможе бути nullThe follow-up task created with the completion, if one was asked for.13 полів
taskIdnumberобовʼязковий—
textOfTaskstring—
isCompletedboolean—
completedAtstringможе бути nullформат YYYY-MM-DDTHH:mm:ss
deadlinestringSchool-local wall time; a point in time only when hasTime is true.формат YYYY-MM-DDTHH:mm:ss
hasTimeboolean—
resultOfTaskstringможе бути null—
notestringможе бути null—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
deadlineBucketstringBoard column, derived on read.Одне з: OVERDUE TODAY TOMORROW WEEK LATER
customFieldsobjectдовільні ключі
Помилки400401403429500
curl -X PATCH "https://your-school.rist.pro/api/task/complete/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resultOfTask": "string",
    "next": {
      "textOfTask": "string",
      "typeId": 1,
      "subtypeId": 1,
      "deadline": "string",
      "hasTime": false,
      "assigneeUserId": 1,
      "note": "string",
      "studentIds": [
        1
      ],
      "leadIds": [
        1
      ],
      "groupIds": [
        1
      ],
      "customFields": {}
    }
  }'
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "completed": {
      "taskId": 1,
      "textOfTask": "string",
      "isCompleted": false,
      "completedAt": "2026-11-09T14:30:00",
      "deadline": "2026-11-09T14:30:00",
      "hasTime": false,
      "resultOfTask": "string",
      "note": "string",
      "isArchival": false,
      "updatedAt": "2026-11-09T14:30:00",
      "createdAt": "2026-11-09T14:30:00",
      "deadlineBucket": "OVERDUE",
      "customFields": {}
    },
    "next": {
      "taskId": 1,
      "textOfTask": "string",
      "isCompleted": false,
      "completedAt": "2026-11-09T14:30:00",
      "deadline": "2026-11-09T14:30:00",
      "hasTime": false,
      "resultOfTask": "string",
      "note": "string",
      "isArchival": false,
      "updatedAt": "2026-11-09T14:30:00",
      "createdAt": "2026-11-09T14:30:00",
      "deadlineBucket": "OVERDUE",
      "customFields": {}
    }
  }
}
PATCH

Reopen task

/api/task/reopen/{id}

Return a completed task to open. Fails if the task is not completed; may trigger automations.

reopen_task

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

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

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject13 полів
taskIdnumberобовʼязковий—
textOfTaskstring—
isCompletedboolean—
completedAtstringможе бути nullформат YYYY-MM-DDTHH:mm:ss
deadlinestringSchool-local wall time; a point in time only when hasTime is true.формат YYYY-MM-DDTHH:mm:ss
hasTimeboolean—
resultOfTaskstringможе бути null—
notestringможе бути null—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
deadlineBucketstringBoard column, derived on read.Одне з: OVERDUE TODAY TOMORROW WEEK LATER
customFieldsobjectдовільні ключі
Помилки400401403429500
curl -X PATCH "https://your-school.rist.pro/api/task/reopen/1" \
  -H "Authorization: Bearer $RIST_API_KEY"
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "taskId": 1,
    "textOfTask": "string",
    "isCompleted": false,
    "completedAt": "2026-11-09T14:30:00",
    "deadline": "2026-11-09T14:30:00",
    "hasTime": false,
    "resultOfTask": "string",
    "note": "string",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00",
    "deadlineBucket": "OVERDUE",
    "customFields": {}
  }
}