Lead sources

Sales · 6 операцій

GETList lead sources/api/source-of-leadGETList groups of lead sources/api/group-of-sourcesPOSTCreate lead source/api/source-of-leadPOSTCreate group of lead sources/api/group-of-sourcesPUTUpdate group of lead sources/api/group-of-sources/{id}PUTUpdate lead source/api/source-of-lead/{id}

GET

List lead sources

/api/source-of-lead

Where leads come from (ads, referrals and so on), grouped.

list_sources_of_lead

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

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

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

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

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

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

Відповідь · 200

application/json

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

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

dataobject4 поля

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

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

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

sourcesOfLeadobject[]обовʼязковий9 полів

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

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

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

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

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

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

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

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

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

Помилки400401403429500

curl "https://your-school.rist.pro/api/source-of-lead?sourceOfLeadIds=0&nameOfSource=string&isArchival=false" \
  -H "Authorization: Bearer $RIST_API_KEY"

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

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "total": 0,
    "totalPages": 0,
    "currentPage": 0,
    "sourcesOfLead": [
      {
        "sourceOfLeadId": 1,
        "groupOfSourcesId": 1,
        "nameOfSource": "string",
        "code": "string",
        "note": "string",
        "order": 0,
        "isArchival": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00"
      }
    ]
  }
}

GET

List groups of lead sources

/api/group-of-sources

Groups that lead sources belong to (e.g. "Ads", "Referrals"). A new source needs a group id.

list_groups_of_sources

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

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

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

groupOfSourcesIdsnumber[]—

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

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

Відповідь · 200

application/json

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

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

dataobject4 поля

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

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

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

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

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

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

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

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

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

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

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

Помилки400401403429500

curl "https://your-school.rist.pro/api/group-of-sources?nameOfGroup=string&isArchival=false" \
  -H "Authorization: Bearer $RIST_API_KEY"

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

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "total": 0,
    "totalPages": 0,
    "currentPage": 0,
    "groupsOfSources": [
      {
        "groupOfSourcesId": 1,
        "nameOfGroup": "string",
        "note": "string",
        "order": 0,
        "isArchival": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00"
      }
    ]
  }
}

POST

Create lead source

/api/source-of-lead

Add a lead source in a group (GET /api/group-of-sources) with a name and an optional note.

create_source_of_lead

Тіло запиту

application/json · object

groupOfSourcesIdnumberобовʼязковиймін. 1

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

codestringдовжина 1–30

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

Відповідь · 201

application/json

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

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

dataobject9 полів

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

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

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

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

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

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

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

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

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

Помилки400401403429500

curl -X POST "https://your-school.rist.pro/api/source-of-lead" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "groupOfSourcesId": 1,
    "nameOfSource": "string",
    "code": "string",
    "note": "string"
  }'

const response = await fetch("https://your-school.rist.pro/api/source-of-lead", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "groupOfSourcesId": 1,
    "nameOfSource": "string",
    "code": "string",
    "note": "string"
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.post(
    "https://your-school.rist.pro/api/source-of-lead",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "groupOfSourcesId": 1,
        "nameOfSource": "string",
        "code": "string",
        "note": "string"
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 201,
  "message": "Operation completed successfully",
  "data": {
    "sourceOfLeadId": 1,
    "groupOfSourcesId": 1,
    "nameOfSource": "string",
    "code": "string",
    "note": "string",
    "order": 0,
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}

POST

Create group of lead sources

/api/group-of-sources

Add a group for lead sources (name, optional note).

create_group_of_sources

Тіло запиту

application/json · object

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

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

Відповідь · 201

application/json

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

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

dataobject7 полів

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

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

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

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

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

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

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

Помилки400401403429500

curl -X POST "https://your-school.rist.pro/api/group-of-sources" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfGroup": "string",
    "note": "string"
  }'

const response = await fetch("https://your-school.rist.pro/api/group-of-sources", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "nameOfGroup": "string",
    "note": "string"
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.post(
    "https://your-school.rist.pro/api/group-of-sources",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "nameOfGroup": "string",
        "note": "string"
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 201,
  "message": "Operation completed successfully",
  "data": {
    "groupOfSourcesId": 1,
    "nameOfGroup": "string",
    "note": "string",
    "order": 0,
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}

PUT

Update group of lead sources

/api/group-of-sources/{id}

Change name or note of a group of lead sources; name is always required.

update_group_of_sources

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

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

Тіло запиту

application/json · object

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

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

Відповідь · 200

application/json

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

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

dataobject7 полів

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

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

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

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

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

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

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

Помилки400401403429500

curl -X PUT "https://your-school.rist.pro/api/group-of-sources/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfGroup": "string",
    "note": "string"
  }'

const response = await fetch("https://your-school.rist.pro/api/group-of-sources/1", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "nameOfGroup": "string",
    "note": "string"
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.put(
    "https://your-school.rist.pro/api/group-of-sources/1",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "nameOfGroup": "string",
        "note": "string"
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "groupOfSourcesId": 1,
    "nameOfGroup": "string",
    "note": "string",
    "order": 0,
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}

PUT

Update lead source

/api/source-of-lead/{id}

Change the name or note of a lead source; the name is always required.

update_source_of_lead

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

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

Тіло запиту

application/json · object

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

codestringдовжина 1–30

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

Відповідь · 200

application/json

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

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

dataobject9 полів

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

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

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

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

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

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

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

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

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

Помилки400401403429500

curl -X PUT "https://your-school.rist.pro/api/source-of-lead/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfSource": "string",
    "code": "string",
    "note": "string"
  }'

const response = await fetch("https://your-school.rist.pro/api/source-of-lead/1", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "nameOfSource": "string",
    "code": "string",
    "note": "string"
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.put(
    "https://your-school.rist.pro/api/source-of-lead/1",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "nameOfSource": "string",
        "code": "string",
        "note": "string"
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "sourceOfLeadId": 1,
    "groupOfSourcesId": 1,
    "nameOfSource": "string",
    "code": "string",
    "note": "string",
    "order": 0,
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}