Groups

Learning · 4 операції

GETList groups/api/groupGETGet group/api/group/{id}POSTCreate group/api/groupPATCHUpdate group/api/group/{id}

GET

List groups

/api/group

Study groups with filters and pagination. studentsCount is the number of active students; studentsCountFrom/studentsCountTo filter by it (empty groups count as 0).

list_groups

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

pagenumberмін. 1 · за замовчуванням 1

pageSizenumber1–250 · за замовчуванням 20

sortBystringОдне з: status nameOfGroup teacher levelOfKnowledge

sortOrderstringОдне з: ASC DESC

groupIdsnumber[]—

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

statusOfGroupIdsnumber[]—

nameOfGroupstringобовʼязковийдовжина макс. 150

Показати ще 15

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

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

teacherIdsnumber[]—

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

levelOfKnowledgeIdsnumber[]—

classOfStudentIdsnumber[]—

subjectIdsnumber[]—

typeOfLessonIdsnumber[]—

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

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

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

isArchivalobjectобовʼязковийза замовчуванням false

studentsCountFromnumberAt least this many active students.

studentsCountTonumberAt most this many active students; empty groups included.

cfstring[]—

Відповідь · 200

application/json

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

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

dataobject4 поля

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

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

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

groupsobject[]обовʼязковий14 полів

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

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

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

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

dateStartstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

dateEndstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

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

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

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

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

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

regularLessonsobject[]обовʼязковий3 поля

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

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

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

studentsCountnumberActive students; absent when the role cannot see group students.

customFieldsobjectCustom field values; the table row shows the columns chosen in the preset.довільні ключі

Помилки400401403429500

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

const response = await fetch("https://your-school.rist.pro/api/group", {
  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/group",
    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,
    "groups": [
      {
        "groupId": 1,
        "nameOfGroup": "string",
        "description": "string",
        "limitOfStudents": 0,
        "dateStart": "2026-11-09T14:30:00",
        "dateEnd": "2026-11-09T14:30:00",
        "note": "string",
        "avatarUrl": "string",
        "isArchival": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00",
        "regularLessons": [
          {
            "dayOfWeek": 0,
            "timeStart": "string",
            "timeEnd": "string"
          }
        ],
        "studentsCount": 0,
        "customFields": {}
      }
    ]
  }
}

GET

Get group

/api/group/{id}

One study group with its students and teachers.

get_group

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

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

Відповідь · 200

application/json

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

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

dataobject12 полів

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

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

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

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

dateStartstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

dateEndstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

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

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

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

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

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

customFieldsobjectдовільні ключі

Помилки400401403429500

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

const response = await fetch("https://your-school.rist.pro/api/group/1", {
  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/group/1",
    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": {
    "groupId": 1,
    "nameOfGroup": "string",
    "description": "string",
    "limitOfStudents": 0,
    "dateStart": "2026-11-09T14:30:00",
    "dateEnd": "2026-11-09T14:30:00",
    "note": "string",
    "avatarUrl": "string",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00",
    "customFields": {}
  }
}

POST

Create group

/api/group

Create a study group with teachers, subjects, lesson types, level and dates.

create_group

Тіло запиту

application/json · object

nameOfGroupstringобовʼязковийдовжина 1–150

descriptionstringобовʼязковийможе бути nullдовжина макс. 100

limitOfStudentsnumberмін. 1

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

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

notestringобовʼязковийможе бути nullдовжина макс. 1500

statusOfGroupIdnumberобовʼязковийможе бути nullмін. 1

teacherIdsnumber[]обовʼязковиймін. 1

levelOfKnowledgeIdnumberобовʼязковийможе бути nullмін. 1

classOfStudentIdsnumber[]обовʼязковиймін. 1

subjectIdsnumber[]обовʼязковиймін. 1

typeOfLessonIdsnumber[]обовʼязковиймін. 1

customFieldsobjectдовільні ключі

Відповідь · 201

application/json

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

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

dataobject14 полів

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

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

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

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

dateStartstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

dateEndstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

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

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

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

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

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

regularLessonsobject[]обовʼязковий3 поля

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

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

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

studentsCountnumberActive students; absent when the role cannot see group students.

customFieldsobjectCustom field values; the table row shows the columns chosen in the preset.довільні ключі

Помилки400401403429500

curl -X POST "https://your-school.rist.pro/api/group" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfGroup": "string",
    "description": "string",
    "limitOfStudents": 1,
    "dateStart": "string",
    "dateEnd": "string",
    "note": "string",
    "statusOfGroupId": 1,
    "teacherIds": [
      1
    ],
    "levelOfKnowledgeId": 1,
    "classOfStudentIds": [
      1
    ],
    "subjectIds": [
      1
    ],
    "typeOfLessonIds": [
      1
    ],
    "customFields": {}
  }'

const response = await fetch("https://your-school.rist.pro/api/group", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "nameOfGroup": "string",
    "description": "string",
    "limitOfStudents": 1,
    "dateStart": "string",
    "dateEnd": "string",
    "note": "string",
    "statusOfGroupId": 1,
    "teacherIds": [
      1
    ],
    "levelOfKnowledgeId": 1,
    "classOfStudentIds": [
      1
    ],
    "subjectIds": [
      1
    ],
    "typeOfLessonIds": [
      1
    ],
    "customFields": {}
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.post(
    "https://your-school.rist.pro/api/group",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "nameOfGroup": "string",
        "description": "string",
        "limitOfStudents": 1,
        "dateStart": "string",
        "dateEnd": "string",
        "note": "string",
        "statusOfGroupId": 1,
        "teacherIds": [
            1
        ],
        "levelOfKnowledgeId": 1,
        "classOfStudentIds": [
            1
        ],
        "subjectIds": [
            1
        ],
        "typeOfLessonIds": [
            1
        ],
        "customFields": {}
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 201,
  "message": "Operation completed successfully",
  "data": {
    "groupId": 1,
    "nameOfGroup": "string",
    "description": "string",
    "limitOfStudents": 0,
    "dateStart": "2026-11-09T14:30:00",
    "dateEnd": "2026-11-09T14:30:00",
    "note": "string",
    "avatarUrl": "string",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00",
    "regularLessons": [
      {
        "dayOfWeek": 0,
        "timeStart": "string",
        "timeEnd": "string"
      }
    ],
    "studentsCount": 0,
    "customFields": {}
  }
}

PATCH

Update group

/api/group/{id}

Change fields of a study group. Send only the fields to change; list fields replace the whole list.

update_group

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

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

Тіло запиту

application/json · object

nameOfGroupstringдовжина 1–150

descriptionstringможе бути nullдовжина макс. 100

limitOfStudentsnumberмін. 1

dateStartstringможе бути null—

dateEndstringможе бути null—

notestringможе бути nullдовжина макс. 1500

statusOfGroupIdnumberможе бути nullмін. 1

teacherIdsnumber[]мін. 1

levelOfKnowledgeIdnumberможе бути nullмін. 1

classOfStudentIdsnumber[]мін. 1

subjectIdsnumber[]мін. 1

typeOfLessonIdsnumber[]мін. 1

customFieldsobjectдовільні ключі

Відповідь · 200

application/json

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

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

dataobject14 полів

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

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

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

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

dateStartstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

dateEndstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

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

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

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

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

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

regularLessonsobject[]обовʼязковий3 поля

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

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

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

studentsCountnumberActive students; absent when the role cannot see group students.

customFieldsobjectCustom field values; the table row shows the columns chosen in the preset.довільні ключі

Помилки400401403429500

curl -X PATCH "https://your-school.rist.pro/api/group/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfGroup": "string",
    "description": "string",
    "limitOfStudents": 1,
    "dateStart": "string",
    "dateEnd": "string",
    "note": "string",
    "statusOfGroupId": 1,
    "teacherIds": [
      1
    ],
    "levelOfKnowledgeId": 1,
    "classOfStudentIds": [
      1
    ],
    "subjectIds": [
      1
    ],
    "typeOfLessonIds": [
      1
    ],
    "customFields": {}
  }'

const response = await fetch("https://your-school.rist.pro/api/group/1", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "nameOfGroup": "string",
    "description": "string",
    "limitOfStudents": 1,
    "dateStart": "string",
    "dateEnd": "string",
    "note": "string",
    "statusOfGroupId": 1,
    "teacherIds": [
      1
    ],
    "levelOfKnowledgeId": 1,
    "classOfStudentIds": [
      1
    ],
    "subjectIds": [
      1
    ],
    "typeOfLessonIds": [
      1
    ],
    "customFields": {}
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.patch(
    "https://your-school.rist.pro/api/group/1",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "nameOfGroup": "string",
        "description": "string",
        "limitOfStudents": 1,
        "dateStart": "string",
        "dateEnd": "string",
        "note": "string",
        "statusOfGroupId": 1,
        "teacherIds": [
            1
        ],
        "levelOfKnowledgeId": 1,
        "classOfStudentIds": [
            1
        ],
        "subjectIds": [
            1
        ],
        "typeOfLessonIds": [
            1
        ],
        "customFields": {}
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "groupId": 1,
    "nameOfGroup": "string",
    "description": "string",
    "limitOfStudents": 0,
    "dateStart": "2026-11-09T14:30:00",
    "dateEnd": "2026-11-09T14:30:00",
    "note": "string",
    "avatarUrl": "string",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00",
    "regularLessons": [
      {
        "dayOfWeek": 0,
        "timeStart": "string",
        "timeEnd": "string"
      }
    ],
    "studentsCount": 0,
    "customFields": {}
  }
}