Fields

Settings · 2 операції

GETList system field settings/api/system-fieldGETList custom fields/api/custom-field

GET

List system field settings

/api/system-field

Which built-in fields of each entity (student, lead, lesson and others) are required or hidden in this school.

list_system_fields

Відповідь · 200

application/json

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

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

dataobject1 поле

systemFieldsobject[]обовʼязковийFlat list for all entities, loaded once per app load.8 полів

entitystringобовʼязковийОдне з: STUDENT LEAD TEACHER USER CUSTOMER GROUP FINANCE_OPERATION LESSON TASK

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

isRequiredbooleanобовʼязковийEffective requirement: the school override or the registry default.

isLockedbooleanобовʼязковийTechnically required; the toggle can't be turned off.

isHiddenbooleanобовʼязковийHidden from forms and never required, whatever the school set (e.g. middle name when the name format lacks it).

ruleobjectобовʼязковийможе бути nullConditions that make the field required; null means only isRequired applies.

labelstringобовʼязковийможе бути nullSchool-defined label; null means use the frontend translation.

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

Помилки401403429500

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

const response = await fetch("https://your-school.rist.pro/api/system-field", {
  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/system-field",
    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": {
    "systemFields": [
      {
        "entity": "STUDENT",
        "field": "string",
        "isRequired": false,
        "isLocked": false,
        "isHidden": false,
        "rule": {},
        "label": "string",
        "hint": "string"
      }
    ]
  }
}

GET

List custom fields

/api/custom-field

Custom field definitions (optionally of one entity) with type, options and group. Pass values in customFields by definition id when creating or updating records.

list_custom_fields

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

entitystringОдне з: STUDENT LEAD TEACHER USER CUSTOMER GROUP FINANCE_OPERATION LESSON STUDENT_SUBSCRIPTION TASK

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

Відповідь · 200

application/json

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

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

dataobject5 полів

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

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

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

customFieldDefinitionsobject[]обовʼязковий16 полів

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

entitystringобовʼязковийОдне з: STUDENT LEAD TEACHER USER CUSTOMER GROUP FINANCE_OPERATION LESSON STUDENT_SUBSCRIPTION TASK

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

typestringобовʼязковийОдне з: URL TEXT TEXTAREA NUMBER DATE DATETIME TIME CHECKBOX SELECT MULTI_SELECT

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

customFieldGroupsobject[]обовʼязковий7 полів

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

entitystringобовʼязковийОдне з: STUDENT LEAD TEACHER USER CUSTOMER GROUP FINANCE_OPERATION LESSON STUDENT_SUBSCRIPTION TASK

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

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

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

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

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

Помилки400401403429500

curl "https://your-school.rist.pro/api/custom-field?isArchival=false" \
  -H "Authorization: Bearer $RIST_API_KEY"

const response = await fetch("https://your-school.rist.pro/api/custom-field?isArchival=false", {
  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/custom-field",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    params={
        "isArchival": False
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "total": 0,
    "totalPages": 0,
    "currentPage": 0,
    "customFieldDefinitions": [
      {
        "customFieldDefinitionId": 1,
        "entity": "STUDENT",
        "label": "string",
        "type": "URL",
        "placeholder": "string",
        "hint": "string",
        "isRequired": false,
        "isShowInTable": false,
        "rule": {},
        "order": 0,
        "isArchival": false,
        "groupId": 1,
        "valuesCount": 0,
        "options": [
          {
            "customFieldOptionId": 1,
            "label": "string",
            "order": 0
          }
        ],
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00"
      }
    ],
    "customFieldGroups": [
      {
        "customFieldGroupId": 1,
        "entity": "STUDENT",
        "label": "string",
        "order": 0,
        "isCollapsedByDefault": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00"
      }
    ]
  }
}