Students and customersCustomers

Customers

Students and customers · 7 операцій

GET

List customers of a student

/api/student/customer

Customers (parents or other payers) linked to a student; pass studentId.

list_student_customers

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

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

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataanyПоля data ще не описані.
Помилки400401403429500
curl "https://your-school.rist.pro/api/student/customer?studentId=1" \
  -H "Authorization: Bearer $RIST_API_KEY"
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": …
}
GET

List customers

/api/customer

Customers (parents and other payers) with search and filters. Paginated.

list_customers

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

pagenumberмін. 1 · за замовчуванням 1
pageSizenumber1–250 · за замовчуванням 20
sortBystringОдне з: name manager emails phones messengers links
sortOrderstringОдне з: ASC DESC
customerIdnumberобовʼязковий—
searchstringобовʼязковий—
firstNamestringобовʼязковий—
lastNamestringобовʼязковий—
Показати ще 8
middleNamestringобовʼязковий—
genderstringобовʼязковийОдне з: MALE FEMALE
notestringобовʼязковий—
managerIdsnumber[]—
relationsToStudentstring[]Одне з: MOTHER FATHER GRANDMOTHER GRANDFATHER
typesOfMessengerstring[]Messenger channels the customer has a connected chat in; several values are OR-ed.Одне з: TELEGRAM_BOT INSTAGRAM FACEBOOK IMESSAGE
isArchivalobjectобовʼязковийза замовчуванням false
cfstring[]—

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject4 поля
totalnumberобовʼязковий—
totalPagesnumberобовʼязковий—
currentPagenumberобовʼязковий—
customersobject[]обовʼязковий16 полів
customerIdnumberобовʼязковий—
firstNamestringобовʼязковий—
lastNamestringобовʼязковийможе бути null—
middleNamestringобовʼязковийможе бути null—
contactsobject[]обовʼязковий3 поля
typestringобовʼязковий—
valuestringобовʼязковий—
labelstringобовʼязковийможе бути null—
dateOfBirthstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss
genderstringобовʼязковийОдне з: MALE FEMALE
relationToStudentstringобовʼязковийможе бути nullОдне з: MOTHER FATHER GRANDMOTHER GRANDFATHER
notestringобовʼязковийможе бути null—
managerobjectможе бути null4 поля
idnumberобовʼязковий—
firstNamestringобовʼязковий—
lastNamestringобовʼязковийможе бути null—
isArchivalbooleanобовʼязковий—
avatarUrlstringобовʼязковийможе бути null—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
chatsobject[]обовʼязковийConnected chats, shown as channel icons in the table row.4 поля
chatParticipantIdnumberобовʼязковий—
chatIdnumberобовʼязковий—
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
chatobjectAlways present at runtime; optional because card selects are built dynamically and TS cannot prove the nested object exists.5 полів
chatIdnumberобовʼязковий—
contactNamestringобовʼязковийможе бути null—
avatarstringобовʼязковийможе бути null—
lastMessageAtstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss
messengerobjectобовʼязковий4 поля
messengerIdnumberобовʼязковий—
nameOfMessengerstringобовʼязковий—
typeOfMessengerstringобовʼязковийОдне з: TELEGRAM_BOT INSTAGRAM FACEBOOK IMESSAGE
capabilitiesobjectобовʼязковийможе бути nullWhat the channel supports; null when its adapter is not registered, so the chat is read-only.
customFieldsobjectCustom field values for the columns chosen in the table preset.довільні ключі
Помилки400401403429500
curl "https://your-school.rist.pro/api/customer" \
  -H "Authorization: Bearer $RIST_API_KEY"
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "total": 0,
    "totalPages": 0,
    "currentPage": 0,
    "customers": [
      {
        "customerId": 1,
        "firstName": "string",
        "lastName": "string",
        "middleName": "string",
        "contacts": [
          {
            "type": "string",
            "value": "string",
            "label": "string"
          }
        ],
        "dateOfBirth": "2026-11-09T14:30:00",
        "gender": "MALE",
        "relationToStudent": "MOTHER",
        "note": "string",
        "manager": {
          "id": 1,
          "firstName": "string",
          "lastName": "string",
          "isArchival": false
        },
        "avatarUrl": "string",
        "isArchival": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00",
        "chats": [
          {
            "chatParticipantId": 1,
            "chatId": 1,
            "createdAt": "2026-11-09T14:30:00",
            "chat": {
              "chatId": 1,
              "contactName": "string",
              "avatar": "string",
              "lastMessageAt": "2026-11-09T14:30:00",
              "messenger": {
                "messengerId": 1,
                "nameOfMessenger": "string",
                "typeOfMessenger": "TELEGRAM_BOT",
                "capabilities": {}
              }
            }
          }
        ],
        "customFields": {}
      }
    ]
  }
}
GET

Get customer card

/api/customer/{id}

Full customer card: contacts, linked students, custom fields.

get_customer

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

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

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject17 полів
customerIdnumberобовʼязковий—
firstNamestringобовʼязковий—
lastNamestringобовʼязковийможе бути null—
middleNamestringобовʼязковийможе бути null—
contactsobject[]обовʼязковий3 поля
typestringобовʼязковий—
valuestringобовʼязковий—
labelstringобовʼязковийможе бути null—
dateOfBirthstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss
genderstringобовʼязковийОдне з: MALE FEMALE
relationToStudentstringобовʼязковийможе бути nullОдне з: MOTHER FATHER GRANDMOTHER GRANDFATHER
notestringобовʼязковийможе бути null—
avatarUrlstringобовʼязковийможе бути null—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
userobjectобовʼязковийможе бути null5 полів
idnumberобовʼязковий—
firstNamestringобовʼязковий—
lastNamestringобовʼязковийможе бути null—
emailstringобовʼязковий—
isArchivalbooleanобовʼязковий—
managerobjectможе бути null4 поля
idnumberобовʼязковий—
firstNamestringобовʼязковий—
lastNamestringобовʼязковийможе бути null—
isArchivalbooleanобовʼязковий—
chatsobject[]обовʼязковий4 поля
chatParticipantIdnumberобовʼязковий—
chatIdnumberобовʼязковий—
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
chatobjectAlways present at runtime; optional because card selects are built dynamically and TS cannot prove the nested object exists.5 полів
chatIdnumberобовʼязковий—
contactNamestringобовʼязковийможе бути null—
avatarstringобовʼязковийможе бути null—
lastMessageAtstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss
messengerobjectобовʼязковий4 поля
messengerIdnumberобовʼязковий—
nameOfMessengerstringобовʼязковий—
typeOfMessengerstringобовʼязковийОдне з: TELEGRAM_BOT INSTAGRAM FACEBOOK IMESSAGE
capabilitiesobjectобовʼязковийможе бути nullWhat the channel supports; null when its adapter is not registered, so the chat is read-only.
customFieldsobjectдовільні ключі
Помилки400401403429500
curl "https://your-school.rist.pro/api/customer/1" \
  -H "Authorization: Bearer $RIST_API_KEY"
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "customerId": 1,
    "firstName": "string",
    "lastName": "string",
    "middleName": "string",
    "contacts": [
      {
        "type": "string",
        "value": "string",
        "label": "string"
      }
    ],
    "dateOfBirth": "2026-11-09T14:30:00",
    "gender": "MALE",
    "relationToStudent": "MOTHER",
    "note": "string",
    "avatarUrl": "string",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00",
    "user": {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "isArchival": false
    },
    "manager": {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "isArchival": false
    },
    "chats": [
      {
        "chatParticipantId": 1,
        "chatId": 1,
        "createdAt": "2026-11-09T14:30:00",
        "chat": {
          "chatId": 1,
          "contactName": "string",
          "avatar": "string",
          "lastMessageAt": "2026-11-09T14:30:00",
          "messenger": {
            "messengerId": 1,
            "nameOfMessenger": "string",
            "typeOfMessenger": "TELEGRAM_BOT",
            "capabilities": {}
          }
        }
      }
    ],
    "customFields": {}
  }
}
GET

List students of a customer

/api/customer/{id}/students

Students linked to one customer.

list_customer_students

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

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

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataanyПоля data ще не описані.
Помилки400401403429500
curl "https://your-school.rist.pro/api/customer/1/students" \
  -H "Authorization: Bearer $RIST_API_KEY"
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": …
}
POST

Create customer

/api/customer

Create a customer card, optionally linked to students (studentIds). Look the customer up with search first to avoid duplicates.

create_customer

Тіло запиту

application/json · object

firstNamestringобовʼязковийдовжина 1–30
lastNamestringможе бути nullдовжина макс. 30
middleNamestringобовʼязковийможе бути nullдовжина макс. 30
contactsobject[]обовʼязковий3 поля
typestringобовʼязковийОдне з: PHONE EMAIL MESSENGER URL
valuestringобовʼязковийдовжина 1–255
labelstringобовʼязковийможе бути nullдовжина макс. 50
dateOfBirthstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss
genderstringобовʼязковийОдне з: MALE FEMALE
relationToStudentstringобовʼязковийможе бути nullОдне з: MOTHER FATHER GRANDMOTHER GRANDFATHER
notestringобовʼязковийможе бути nullдовжина макс. 1500
managerIdnumberможе бути nullмін. 1
studentIdsnumber[]—
customFieldsobjectдовільні ключі

Відповідь · 201

application/json

statusCodenumberобовʼязковийприклад 201
messagestringобовʼязковий—
dataobject16 полів
customerIdnumberобовʼязковий—
firstNamestringобовʼязковий—
lastNamestringобовʼязковийможе бути null—
middleNamestringобовʼязковийможе бути null—
contactsobject[]обовʼязковий3 поля
typestringобовʼязковий—
valuestringобовʼязковий—
labelstringобовʼязковийможе бути null—
dateOfBirthstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss
genderstringобовʼязковийОдне з: MALE FEMALE
relationToStudentstringобовʼязковийможе бути nullОдне з: MOTHER FATHER GRANDMOTHER GRANDFATHER
notestringобовʼязковийможе бути null—
managerobjectможе бути null4 поля
idnumberобовʼязковий—
firstNamestringобовʼязковий—
lastNamestringобовʼязковийможе бути null—
isArchivalbooleanобовʼязковий—
avatarUrlstringобовʼязковийможе бути null—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
chatsobject[]обовʼязковийConnected chats, shown as channel icons in the table row.4 поля
chatParticipantIdnumberобовʼязковий—
chatIdnumberобовʼязковий—
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
chatobjectAlways present at runtime; optional because card selects are built dynamically and TS cannot prove the nested object exists.5 полів
chatIdnumberобовʼязковий—
contactNamestringобовʼязковийможе бути null—
avatarstringобовʼязковийможе бути null—
lastMessageAtstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss
messengerobjectобовʼязковий4 поля
messengerIdnumberобовʼязковий—
nameOfMessengerstringобовʼязковий—
typeOfMessengerstringобовʼязковийОдне з: TELEGRAM_BOT INSTAGRAM FACEBOOK IMESSAGE
capabilitiesobjectобовʼязковийможе бути nullWhat the channel supports; null when its adapter is not registered, so the chat is read-only.
customFieldsobjectCustom field values for the columns chosen in the table preset.довільні ключі
Помилки400401403429500
curl -X POST "https://your-school.rist.pro/api/customer" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "string",
    "lastName": "string",
    "middleName": "string",
    "contacts": [
      {
        "type": "PHONE",
        "value": "string",
        "label": "string"
      }
    ],
    "dateOfBirth": "2026-11-09T14:30:00",
    "gender": "MALE",
    "relationToStudent": "MOTHER",
    "note": "string",
    "managerId": 1,
    "studentIds": [
      1
    ],
    "customFields": {}
  }'
Приклад відповіді · 201
{
  "statusCode": 201,
  "message": "Operation completed successfully",
  "data": {
    "customerId": 1,
    "firstName": "string",
    "lastName": "string",
    "middleName": "string",
    "contacts": [
      {
        "type": "string",
        "value": "string",
        "label": "string"
      }
    ],
    "dateOfBirth": "2026-11-09T14:30:00",
    "gender": "MALE",
    "relationToStudent": "MOTHER",
    "note": "string",
    "manager": {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "isArchival": false
    },
    "avatarUrl": "string",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00",
    "chats": [
      {
        "chatParticipantId": 1,
        "chatId": 1,
        "createdAt": "2026-11-09T14:30:00",
        "chat": {
          "chatId": 1,
          "contactName": "string",
          "avatar": "string",
          "lastMessageAt": "2026-11-09T14:30:00",
          "messenger": {
            "messengerId": 1,
            "nameOfMessenger": "string",
            "typeOfMessenger": "TELEGRAM_BOT",
            "capabilities": {}
          }
        }
      }
    ],
    "customFields": {}
  }
}
PATCH

Update customer

/api/customer/{id}

Change fields of a customer card. Send only the fields to change: contacts, when sent, replace the whole contact list.

update_customer

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

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

Тіло запиту

application/json · object

firstNamestringдовжина 1–30
lastNamestringможе бути nullдовжина макс. 30
middleNamestringможе бути nullдовжина макс. 30
contactsobject[]3 поля
typestringобовʼязковийОдне з: PHONE EMAIL MESSENGER URL
valuestringобовʼязковийдовжина 1–255
labelstringобовʼязковийможе бути nullдовжина макс. 50
dateOfBirthstringможе бути nullформат YYYY-MM-DDTHH:mm:ss
genderstringОдне з: MALE FEMALE
relationToStudentstringможе бути nullОдне з: MOTHER FATHER GRANDMOTHER GRANDFATHER
notestringможе бути nullдовжина макс. 1500
managerIdnumberможе бути nullмін. 1
studentIdsnumber[]—
customFieldsobjectдовільні ключі

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject16 полів
customerIdnumberобовʼязковий—
firstNamestringобовʼязковий—
lastNamestringобовʼязковийможе бути null—
middleNamestringобовʼязковийможе бути null—
contactsobject[]обовʼязковий3 поля
typestringобовʼязковий—
valuestringобовʼязковий—
labelstringобовʼязковийможе бути null—
dateOfBirthstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss
genderstringобовʼязковийОдне з: MALE FEMALE
relationToStudentstringобовʼязковийможе бути nullОдне з: MOTHER FATHER GRANDMOTHER GRANDFATHER
notestringобовʼязковийможе бути null—
managerobjectможе бути null4 поля
idnumberобовʼязковий—
firstNamestringобовʼязковий—
lastNamestringобовʼязковийможе бути null—
isArchivalbooleanобовʼязковий—
avatarUrlstringобовʼязковийможе бути null—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
chatsobject[]обовʼязковийConnected chats, shown as channel icons in the table row.4 поля
chatParticipantIdnumberобовʼязковий—
chatIdnumberобовʼязковий—
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
chatobjectAlways present at runtime; optional because card selects are built dynamically and TS cannot prove the nested object exists.5 полів
chatIdnumberобовʼязковий—
contactNamestringобовʼязковийможе бути null—
avatarstringобовʼязковийможе бути null—
lastMessageAtstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss
messengerobjectобовʼязковий4 поля
messengerIdnumberобовʼязковий—
nameOfMessengerstringобовʼязковий—
typeOfMessengerstringобовʼязковийОдне з: TELEGRAM_BOT INSTAGRAM FACEBOOK IMESSAGE
capabilitiesobjectобовʼязковийможе бути nullWhat the channel supports; null when its adapter is not registered, so the chat is read-only.
customFieldsobjectCustom field values for the columns chosen in the table preset.довільні ключі
Помилки400401403429500
curl -X PATCH "https://your-school.rist.pro/api/customer/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "string",
    "lastName": "string",
    "middleName": "string",
    "contacts": [
      {
        "type": "PHONE",
        "value": "string",
        "label": "string"
      }
    ],
    "dateOfBirth": "2026-11-09T14:30:00",
    "gender": "MALE",
    "relationToStudent": "MOTHER",
    "note": "string",
    "managerId": 1,
    "studentIds": [
      1
    ],
    "customFields": {}
  }'
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "customerId": 1,
    "firstName": "string",
    "lastName": "string",
    "middleName": "string",
    "contacts": [
      {
        "type": "string",
        "value": "string",
        "label": "string"
      }
    ],
    "dateOfBirth": "2026-11-09T14:30:00",
    "gender": "MALE",
    "relationToStudent": "MOTHER",
    "note": "string",
    "manager": {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "isArchival": false
    },
    "avatarUrl": "string",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00",
    "chats": [
      {
        "chatParticipantId": 1,
        "chatId": 1,
        "createdAt": "2026-11-09T14:30:00",
        "chat": {
          "chatId": 1,
          "contactName": "string",
          "avatar": "string",
          "lastMessageAt": "2026-11-09T14:30:00",
          "messenger": {
            "messengerId": 1,
            "nameOfMessenger": "string",
            "typeOfMessenger": "TELEGRAM_BOT",
            "capabilities": {}
          }
        }
      }
    ],
    "customFields": {}
  }
}