Search
Reports · 1 операція
GET
Search CRM
/api/searchGlobal search across students, teachers, customers, users, groups, subscriptions and leads by name, email or phone (at least 3 digits). Start here to find ids.
search
Параметри запиту · 1
text—Відповідь · 200
application/json
statusCodeприклад 200message—data7 полів
students5 полів
studentId—firstName—lastName—isArchival—phones—teachers5 полів
teacherId—firstName—lastName—isArchival—phones—customers5 полів
customerId—firstName—lastName—isArchival—phones—users5 полів
id—firstName—lastName—isArchival—phones—groups3 поля
groupId—nameOfGroup—isArchival—subscriptions3 поля
subscriptionId—nameOfSubscription—isArchival—leads5 полів
leadId—studentId—nameOfLead—isArchival—phones—curl "https://your-school.rist.pro/api/search?text=string" \
-H "Authorization: Bearer $RIST_API_KEY"const response = await fetch("https://your-school.rist.pro/api/search?text=string", {
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/search",
headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
params={
"text": "string"
},
)
response.raise_for_status()
data = response.json()["data"]Приклад відповіді · 200
{
"statusCode": 200,
"message": "Operation completed successfully",
"data": {
"students": [
{
"studentId": 1,
"firstName": "string",
"lastName": "string",
"isArchival": false,
"phones": [
"string"
]
}
],
"teachers": [
{
"teacherId": 1,
"firstName": "string",
"lastName": "string",
"isArchival": false,
"phones": [
"string"
]
}
],
"customers": [
{
"customerId": 1,
"firstName": "string",
"lastName": "string",
"isArchival": false,
"phones": [
"string"
]
}
],
"users": [
{
"id": 1,
"firstName": "string",
"lastName": "string",
"isArchival": false,
"phones": [
"string"
]
}
],
"groups": [
{
"groupId": 1,
"nameOfGroup": "string",
"isArchival": false
}
],
"subscriptions": [
{
"subscriptionId": 1,
"nameOfSubscription": "string",
"isArchival": false
}
],
"leads": [
{
"leadId": 1,
"studentId": 1,
"nameOfLead": "string",
"isArchival": false,
"phones": [
"string"
]
}
]
}
}