Fields

Settings · 2 operations

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

Response · 200

application/json

statusCodenumberrequiredexample 200

messagestringrequired—

dataobject1 field

systemFieldsobject[]requiredFlat list for all entities, loaded once per app load.8 fields

entitystringrequiredOne of: STUDENT LEAD TEACHER USER CUSTOMER GROUP FINANCE_OPERATION LESSON TASK

fieldstringrequired—

isRequiredbooleanrequiredEffective requirement: the school override or the registry default.

isLockedbooleanrequiredTechnically required; the toggle can't be turned off.

isHiddenbooleanrequiredHidden from forms and never required, whatever the school set (e.g. middle name when the name format lacks it).

ruleobjectrequirednullableConditions that make the field required; null means only isRequired applies.

labelstringrequirednullableSchool-defined label; null means use the frontend translation.

hintstringrequirednullable—

Errors401403429500

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"]

Response example · 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

Query parameters · 2

entitystringOne of: STUDENT LEAD TEACHER USER CUSTOMER GROUP FINANCE_OPERATION LESSON STUDENT_SUBSCRIPTION TASK

isArchivalobjectrequireddefault false

Response · 200

application/json

statusCodenumberrequiredexample 200

messagestringrequired—

dataobject5 fields

totalnumberrequired—

totalPagesnumberrequired—

currentPagenumberrequired—

customFieldDefinitionsobject[]required16 fields

customFieldDefinitionIdnumberrequired—

entitystringrequiredOne of: STUDENT LEAD TEACHER USER CUSTOMER GROUP FINANCE_OPERATION LESSON STUDENT_SUBSCRIPTION TASK

labelstringrequired—

typestringrequiredOne of: URL TEXT TEXTAREA NUMBER DATE DATETIME TIME CHECKBOX SELECT MULTI_SELECT

placeholderstringrequirednullable—

hintstringrequirednullable—

isRequiredbooleanrequired—

isShowInTablebooleanrequired—

ruleobjectrequirednullable—

ordernumberrequired—

isArchivalbooleanrequired—

groupIdnumberrequirednullable—

valuesCountnumberrequired—

optionsobject[]required3 fields

customFieldOptionIdnumberrequired—

labelstringrequired—

ordernumberrequired—

updatedAtstringrequiredformat YYYY-MM-DDTHH:mm:ss

createdAtstringrequiredformat YYYY-MM-DDTHH:mm:ss

customFieldGroupsobject[]required7 fields

customFieldGroupIdnumberrequired—

entitystringrequiredOne of: STUDENT LEAD TEACHER USER CUSTOMER GROUP FINANCE_OPERATION LESSON STUDENT_SUBSCRIPTION TASK

labelstringrequired—

ordernumberrequired—

isCollapsedByDefaultbooleanrequired—

updatedAtstringrequiredformat YYYY-MM-DDTHH:mm:ss

createdAtstringrequiredformat YYYY-MM-DDTHH:mm:ss

Errors400401403429500

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"]

Response example · 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"
      }
    ]
  }
}