Pipelines

Sales · 7 операцій

GETList sales pipelines/api/pipelineGETGet sales pipeline/api/pipeline/{id}GETList pipeline stages/api/stage-of-pipelinePOSTCreate sales pipeline/api/pipelinePOSTCreate pipeline stage/api/stage-of-pipelinePUTUpdate sales pipeline/api/pipeline/{id}PUTUpdate pipeline stage/api/stage-of-pipeline/{id}

GET

List sales pipelines

/api/pipeline

Sales pipelines. Use the ids to filter leads or to find stages.

list_pipelines

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

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

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

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

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

Відповідь · 200

application/json

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

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

dataobject4 поля

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

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

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

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

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

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

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

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

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

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

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

Помилки400401403429500

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

const response = await fetch("https://your-school.rist.pro/api/pipeline?nameOfPipeline=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/pipeline",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    params={
        "nameOfPipeline": "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,
    "pipelines": [
      {
        "pipelineId": 1,
        "nameOfPipeline": "string",
        "note": "string",
        "order": 0,
        "isArchival": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00"
      }
    ]
  }
}

GET

Get sales pipeline

/api/pipeline/{id}

One sales pipeline with its stages.

get_pipeline

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

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

Відповідь · 200

application/json

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

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

dataobject7 полів

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

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

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

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

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

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

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

Помилки400401403429500

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

const response = await fetch("https://your-school.rist.pro/api/pipeline/1", {
  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/pipeline/1",
    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": {
    "pipelineId": 1,
    "nameOfPipeline": "string",
    "note": "string",
    "order": 0,
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}

GET

List pipeline stages

/api/stage-of-pipeline

Stages of sales pipelines (filter by pipelineId). Use a stage id with PATCH /api/lead/stage/{id}.

list_pipeline_stages

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

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

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

nameOfStagestringдовжина макс. 150

stageIdsnumber[]—

pipelineIdnumber—

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

Відповідь · 200

application/json

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

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

dataobject[]11 полів

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

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

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

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

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

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

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

stageTypestringобовʼязковийОдне з: REGULAR INCOMING CLOSED_WON CLOSED_LOST

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

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

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

Помилки400401403429500

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

const response = await fetch("https://your-school.rist.pro/api/stage-of-pipeline?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/stage-of-pipeline",
    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": [
    {
      "stageId": 1,
      "pipelineId": 1,
      "nameOfStage": "string",
      "color": "string",
      "icon": "string",
      "order": 0,
      "note": "string",
      "stageType": "REGULAR",
      "isArchival": false,
      "updatedAt": "2026-11-09T14:30:00",
      "createdAt": "2026-11-09T14:30:00"
    }
  ]
}

POST

Create sales pipeline

/api/pipeline

Create a sales pipeline (name, 6-digit hex color without #, optional icon and note). Incoming, Closed Won and Closed Lost stages are created with it.

create_pipeline

Тіло запиту

application/json · object

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

colorstringобовʼязковийдовжина 6–6

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

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

Відповідь · 201

application/json

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

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

dataobject7 полів

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

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

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/pipeline" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfPipeline": "string",
    "color": "string",
    "icon": "string",
    "note": "string"
  }'

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

import os
import requests

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

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

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

POST

Create pipeline stage

/api/stage-of-pipeline

Add a regular stage to a pipeline (pipelineId, name, 6-digit hex color). managerIds makes the stage hand new leads to these managers in turn.

create_pipeline_stage

Тіло запиту

application/json · object

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

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

colorstringобовʼязковийдовжина 6–6

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

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

managerIdsnumber[]обовʼязковийможе бути nullмін. 1

Відповідь · 201

application/json

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

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

dataobject11 полів

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

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

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

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

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

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

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

stageTypestringобовʼязковийОдне з: REGULAR INCOMING CLOSED_WON CLOSED_LOST

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

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

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

Помилки400401403429500

curl -X POST "https://your-school.rist.pro/api/stage-of-pipeline" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pipelineId": 1,
    "nameOfStage": "string",
    "color": "string",
    "icon": "string",
    "note": "string",
    "managerIds": [
      1
    ]
  }'

const response = await fetch("https://your-school.rist.pro/api/stage-of-pipeline", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "pipelineId": 1,
    "nameOfStage": "string",
    "color": "string",
    "icon": "string",
    "note": "string",
    "managerIds": [
      1
    ]
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.post(
    "https://your-school.rist.pro/api/stage-of-pipeline",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "pipelineId": 1,
        "nameOfStage": "string",
        "color": "string",
        "icon": "string",
        "note": "string",
        "managerIds": [
            1
        ]
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 201,
  "message": "Operation completed successfully",
  "data": {
    "stageId": 1,
    "pipelineId": 1,
    "nameOfStage": "string",
    "color": "string",
    "icon": "string",
    "order": 0,
    "note": "string",
    "stageType": "REGULAR",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}

PUT

Update sales pipeline

/api/pipeline/{id}

Change name, color, icon and note of a pipeline. Name and color are always required; pass null to clear icon or note.

update_pipeline

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

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

Тіло запиту

application/json · object

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

colorstringобовʼязковийдовжина 6–6

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

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

Відповідь · 200

application/json

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

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

dataobject7 полів

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

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

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/pipeline/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfPipeline": "string",
    "color": "string",
    "icon": "string",
    "note": "string"
  }'

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

import os
import requests

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

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

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

PUT

Update pipeline stage

/api/stage-of-pipeline/{id}

Change name, color, icon and note of a stage; name and color are always required. managerIds, when sent, replaces the whole lead distribution pool (null or [] clears it); omit it to keep the pool.

update_pipeline_stage

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

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

Тіло запиту

application/json · object

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

colorstringобовʼязковийдовжина 6–6

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

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

managerIdsnumber[]обовʼязковийможе бути nullмін. 1

Відповідь · 200

application/json

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

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

dataobject11 полів

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

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

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

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

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

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

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

stageTypestringобовʼязковийОдне з: REGULAR INCOMING CLOSED_WON CLOSED_LOST

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

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

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

Помилки400401403429500

curl -X PUT "https://your-school.rist.pro/api/stage-of-pipeline/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfStage": "string",
    "color": "string",
    "icon": "string",
    "note": "string",
    "managerIds": [
      1
    ]
  }'

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

import os
import requests

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

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "stageId": 1,
    "pipelineId": 1,
    "nameOfStage": "string",
    "color": "string",
    "icon": "string",
    "order": 0,
    "note": "string",
    "stageType": "REGULAR",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}