Департаменты

Заголовки запроса

string

required

API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.

string

required

Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.

string

required

Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.

Департаменты — это иерархические подразделения школы. Каждый департамент может иметь родительский департамент (parentId), за счёт чего строится дерево организационной структуры. Департаменты используются модулем персонала (staff) для распределения сотрудников по подразделениям и назначения руководителей.

Поле extId — внешний идентификатор департамента из системы клиента (CRM, 1C и т.п.). Он уникален в рамках школы среди неудалённых записей, имеет длину от 1 до 50 символов и не может содержать / и пробельные символы (значение должно быть URL-safe — оно используется в путях ext/{extId}). По extId доступны отдельные эндпоинты обновления и удаления.

Все эндпоинты модуля персонала доступны только для школ корпоративного сегмента (Corporate). Запрос от школы другого сегмента будет отклонён.

Требования к правам доступа

Чтение (tree, list) требует права StaffView. Создание, обновление и удаление требуют права StaffManage. Во всех случаях необходима аутентификация по токену и принадлежность школы к сегменту Corporate.

Сервисный пользователь должен быть аутентифицирован по токену и иметь соответствующие права доступа к указанной школе.

Дерево департаментов

GET /saas/v2/staff/department/tree

Требуется аутентификация и право StaffView.

Эндпоинт возвращает плоский массив всех департаментов школы. Иерархия задаётся полем parentId каждого департамента (null — корневой департамент). Само дерево строится на стороне клиента группировкой элементов по parentId.

Ответ

array

required

Массив департаментов школы. Поле parentId указывает на родительский департамент (null — корневой).

curl --location 'https://api.exode.biz/saas/v2/staff/department/tree' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Authorization: Bearer YOUR_TOKEN'

const axios = require('axios');

async function getDepartmentTree() {
  const { data } = await axios.get(
    'https://api.exode.biz/saas/v2/staff/department/tree',
    {
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Authorization': 'Bearer YOUR_TOKEN',
      },
    }
  );
  console.log(data.payload);
}

getDepartmentTree();

{
  "success": true,
  "code": 200,
  "payload": [
    {
      "id": 3,
      "createdAt": "2026-07-02T11:15:47.223Z",
      "updatedAt": "2026-07-02T11:15:47.223Z",
      "archivedAt": null,
      "schoolId": 198,
      "parentId": null,
      "extId": "dep_engineering",
      "name": "Engineering"
    },
    {
      "id": 4,
      "createdAt": "2026-07-02T11:15:47.234Z",
      "updatedAt": "2026-07-02T11:15:47.247Z",
      "archivedAt": null,
      "schoolId": 198,
      "parentId": 3,
      "extId": null,
      "name": "Backend & Infra Team"
    }
  ]
}

{
  "code": 403,
  "success": false,
  "cause": "Forbidden",
  "error": "Доступ к ресурсу ограничен",
  "message": "Доступ к ресурсу ограничен"
}

Список департаментов

GET /saas/v2/staff/department/list

Требуется аутентификация и право StaffView.

В отличие от tree, эндпоинт возвращает пагинированный список департаментов. Параметры пагинации и фильтрации передаются как query-параметры.

Параметры

integer

Количество пропускаемых записей (offset-пагинация). Минимум 0.

integer

Количество возвращаемых записей на странице. От 1 до 1000.

integer

Номер страницы (альтернатива skip). Минимум 1.

array

Массив ID родительских департаментов для фильтрации (до 250 значений). Возвращает только дочерние департаменты указанных родителей.

array

Массив внешних идентификаторов (extId) для фильтрации (до 250 значений, каждый — до 50 символов).

string

Поиск по названию департамента. Максимум 50 символов.

enum

Направление сортировки по дате создания. Возможные значения: ASC, DESC.

Ответ

object

required

Пагинированный объект: items (массив департаментов), page, count, pages, isFirst, isLast, next, prev.

curl --location 'https://api.exode.biz/saas/v2/staff/department/list?take=10&page=1&search=Engineering' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Authorization: Bearer YOUR_TOKEN'

const axios = require('axios');

async function getDepartmentList() {
  const { data } = await axios.get(
    'https://api.exode.biz/saas/v2/staff/department/list',
    {
      params: {
        take: 10,
        page: 1,
        search: 'Engineering',
        parentIds: [3],
      },
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Authorization': 'Bearer YOUR_TOKEN',
      },
    }
  );
  console.log(data.payload);
}

getDepartmentList();

{
  "success": true,
  "code": 200,
  "payload": {
    "page": 1,
    "count": 2,
    "pages": 1,
    "isFirst": true,
    "isLast": true,
    "items": [
      {
        "id": 4,
        "createdAt": "2026-07-02T11:15:47.234Z",
        "updatedAt": "2026-07-02T11:15:47.247Z",
        "archivedAt": null,
        "schoolId": 198,
        "parentId": 3,
        "extId": null,
        "name": "Backend & Infra Team"
      },
      {
        "id": 3,
        "createdAt": "2026-07-02T11:15:47.223Z",
        "updatedAt": "2026-07-02T11:15:47.223Z",
        "archivedAt": null,
        "schoolId": 198,
        "parentId": null,
        "extId": "dep_engineering",
        "name": "Engineering"
      }
    ],
    "next": {
      "skip": 0,
      "take": 10,
      "page": 1
    },
    "prev": {
      "skip": 0,
      "take": 10,
      "page": 1
    }
  }
}

Создание департамента

POST /saas/v2/staff/department/create

Требуется аутентификация и право StaffManage.

Параметры запроса

string

required

Название департамента. От 1 до 100 символов. Пробелы в начале и конце обрезаются автоматически.

string

Внешний идентификатор департамента из системы клиента (CRM/1C). От 1 до 50 символов, не может содержать / и пробельные символы (URL-safe — используется в путях ext/{extId}). Должен быть уникален в рамках школы среди неудалённых департаментов, иначе будет возвращена ошибка StaffDepartmentExtIdIsNotUniq.

integer

ID родительского департамента. Родитель указывается через parentId или parentExtId — передаётся ровно одно поле из пары. Если указан — должен принадлежать той же школе, иначе будет возвращена ошибка StaffDepartmentNotFound. Если родитель не указан ни одним из полей — департамент создаётся корневым.

string

Внешний идентификатор (extId) родительского департамента — альтернатива parentId (передаётся ровно одно поле из пары). От 1 до 50 символов. Родитель должен принадлежать той же школе, иначе будет возвращена ошибка StaffDepartmentNotFound.

integer

Трудоустройство, назначаемое основным руководителем создаваемого департамента. Необязательно. Указывается через primaryManagerEmploymentId или primaryManagerEmploymentExtId.

string

Внешний идентификатор (extId) трудоустройства-руководителя — альтернатива primaryManagerEmploymentId (передаётся не более одного поля из пары). От 1 до 50 символов.

curl --location 'https://api.exode.biz/saas/v2/staff/department/create' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "name": "Engineering",
    "extId": "dep_engineering",
    "parentId": null
  }'

const axios = require('axios');

async function createDepartment() {
  const { data } = await axios.post(
    'https://api.exode.biz/saas/v2/staff/department/create',
    {
      name: 'Engineering',
      extId: 'dep_engineering',
      parentId: null,
    },
    {
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_TOKEN',
      },
    }
  );
  console.log(data.payload);
}

createDepartment();

{
  "success": true,
  "code": 201,
  "payload": {
    "id": 3,
    "createdAt": "2026-07-02T11:15:47.223Z",
    "updatedAt": "2026-07-02T11:15:47.223Z",
    "archivedAt": null,
    "schoolId": 198,
    "parentId": null,
    "extId": "dep_engineering",
    "name": "Engineering"
  }
}

{
  "code": 400,
  "success": false,
  "cause": "StaffDepartmentNotFound",
  "message": "Staff department not found",
  "error": "Staff department not found"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffDepartmentExtIdIsNotUniq",
  "message": "Staff department extId is not uniq",
  "error": "Staff department extId is not uniq"
}

Обновление департамента

PUT /saas/v2/staff/department/{departmentId}/update

Требуется аутентификация и право StaffManage.

Тело запроса совпадает с созданием (все поля необязательны): name, extId, родитель (parentId/parentExtId) и основной руководитель (primaryManagerEmploymentId/primaryManagerEmploymentExtId). Передавайте только те поля, которые нужно изменить.

Параметры

integer

required

ID обновляемого департамента в рамках школы.

string

Новое название департамента. От 1 до 100 символов. Пробелы в начале и конце обрезаются автоматически.

string

Новый внешний идентификатор департамента (можно переустановить). От 1 до 50 символов, не может содержать / и пробельные символы (URL-safe). Должен быть уникален в рамках школы среди неудалённых департаментов, иначе будет возвращена ошибка StaffDepartmentExtIdIsNotUniq.

integer

Новый родительский департамент (переподчинение). Указывается через parentId или parentExtId. Передайте null, чтобы сделать департамент корневым. Новый родитель должен принадлежать той же школе (StaffDepartmentNotFound) и не может быть самим департаментом или его потомком, иначе будет возвращена ошибка StaffDepartmentParentCreatesCycle.

string

Внешний идентификатор (extId) нового родителя — альтернатива parentId (передаётся не более одного поля из пары). От 1 до 50 символов.

integer

Трудоустройство, назначаемое основным руководителем департамента. Указывается через primaryManagerEmploymentId или primaryManagerEmploymentExtId. Передайте null, чтобы снять назначение.

string

curl --location --request PUT 'https://api.exode.biz/saas/v2/staff/department/4/update' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "name": "Backend & Infra Team"
  }'

const axios = require('axios');

async function updateDepartment() {
  const { data } = await axios.put(
    'https://api.exode.biz/saas/v2/staff/department/4/update',
    {
      name: 'Backend & Infra Team',
    },
    {
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_TOKEN',
      },
    }
  );
  console.log(data.payload);
}

updateDepartment();

{
  "success": true,
  "code": 200,
  "payload": {
    "id": 4,
    "createdAt": "2026-07-02T11:15:47.234Z",
    "updatedAt": "2026-07-02T11:15:47.247Z",
    "archivedAt": null,
    "schoolId": 198,
    "parentId": 3,
    "extId": null,
    "name": "Backend & Infra Team"
  }
}

{
  "code": 400,
  "success": false,
  "cause": "StaffDepartmentExtIdIsNotUniq",
  "message": "Staff department extId is not uniq",
  "error": "Staff department extId is not uniq"
}

Обновление департамента по extId

PUT /saas/v2/staff/department/ext/{extId}/update

Требуется аутентификация и право StaffManage.

Аналог обычного обновления, но департамент ищется по внешнему идентификатору (extId) в рамках школы. Тело запроса — то же, что и у PUT /saas/v2/staff/department/{departmentId}/update. Значение extId в пути должно быть URL-encoded. Если департамент с таким extId не найден в рамках школы — будет возвращена ошибка StaffDepartmentNotFound.

Параметры

string

required

Внешний идентификатор департамента в рамках школы. Должен быть URL-encoded.

curl --location --request PUT 'https://api.exode.biz/saas/v2/staff/department/ext/dep_engineering/update' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "name": "Engineering & Research"
  }'

const axios = require('axios');

async function updateDepartmentByExtId() {
  const extId = encodeURIComponent('dep_engineering');

  const { data } = await axios.put(
    `https://api.exode.biz/saas/v2/staff/department/ext/${extId}/update`,
    {
      name: 'Engineering & Research',
    },
    {
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_TOKEN',
      },
    }
  );
  console.log(data.payload);
}

updateDepartmentByExtId();

{
  "success": true,
  "code": 200,
  "payload": {
    "id": 3,
    "createdAt": "2026-07-02T11:15:47.223Z",
    "updatedAt": "2026-07-02T11:15:47.247Z",
    "archivedAt": null,
    "schoolId": 198,
    "parentId": null,
    "extId": "dep_engineering",
    "name": "Engineering & Research"
  }
}

{
  "code": 400,
  "success": false,
  "cause": "StaffDepartmentNotFound",
  "message": "Staff department not found",
  "error": "Staff department not found"
}

Удаление департамента

DELETE /saas/v2/staff/department/{departmentId}/delete

Требуется аутентификация и право StaffManage.

Удалить можно только «листовой» департамент без активных сотрудников:

если у департамента есть дочерние подразделения — вернётся ошибка StaffDepartmentHasChildren (удаление узла в середине дерева осиротило бы его потомков). Сначала удалите или перенесите дочерние департаменты;
если в департаменте есть активные сотрудники — вернётся ошибка StaffDepartmentHasActiveEmployments. Сначала переведите или уволите сотрудников.

Параметры

integer

required

ID удаляемого департамента в рамках школы.

Ответ

integer

required

Количество затронутых (удалённых) записей. При успешном удалении — 1.

curl --location --request DELETE 'https://api.exode.biz/saas/v2/staff/department/4/delete' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Authorization: Bearer YOUR_TOKEN'

const axios = require('axios');

async function deleteDepartment() {
  const { data } = await axios.delete(
    'https://api.exode.biz/saas/v2/staff/department/4/delete',
    {
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Authorization': 'Bearer YOUR_TOKEN',
      },
    }
  );
  console.log(data.payload);
}

deleteDepartment();

{
  "success": true,
  "code": 200,
  "payload": {
    "affected": 1
  }
}

{
  "code": 400,
  "success": false,
  "cause": "StaffDepartmentHasChildren",
  "message": "Staff department has child departments",
  "error": "Staff department has child departments"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffDepartmentHasActiveEmployments",
  "message": "Staff department has active employments",
  "error": "Staff department has active employments"
}

{
  "code": 403,
  "success": false,
  "cause": "Forbidden",
  "error": "Доступ к ресурсу ограничен",
  "message": "Доступ к ресурсу ограничен"
}

Удаление департамента по extId

DELETE /saas/v2/staff/department/ext/{extId}/delete

Требуется аутентификация и право StaffManage.

Аналог обычного удаления, но департамент ищется по внешнему идентификатору (extId) в рамках школы. Действуют те же правила: удалить можно только «листовой» департамент без дочерних подразделений и активных сотрудников (иначе — StaffDepartmentHasChildren / StaffDepartmentHasActiveEmployments). Значение extId в пути должно быть URL-encoded. Если департамент с таким extId не найден в рамках школы — будет возвращена ошибка StaffDepartmentNotFound.

Параметры

string

required

Внешний идентификатор департамента в рамках школы. Должен быть URL-encoded.

Ответ

integer

required

Количество затронутых (удалённых) записей. При успешном удалении — 1.

curl --location --request DELETE 'https://api.exode.biz/saas/v2/staff/department/ext/dep_engineering/delete' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Authorization: Bearer YOUR_TOKEN'

const axios = require('axios');

async function deleteDepartmentByExtId() {
  const extId = encodeURIComponent('dep_engineering');

  const { data } = await axios.delete(
    `https://api.exode.biz/saas/v2/staff/department/ext/${extId}/delete`,
    {
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Authorization': 'Bearer YOUR_TOKEN',
      },
    }
  );
  console.log(data.payload);
}

deleteDepartmentByExtId();

{
  "success": true,
  "code": 200,
  "payload": {
    "affected": 1
  }
}

{
  "code": 400,
  "success": false,
  "cause": "StaffDepartmentNotFound",
  "message": "Staff department not found",
  "error": "Staff department not found"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffDepartmentHasChildren",
  "message": "Staff department has child departments",
  "error": "Staff department has child departments"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffDepartmentHasActiveEmployments",
  "message": "Staff department has active employments",
  "error": "Staff department has active employments"
}

Обновлено: 2026-07-22 12:19 UTC

Работа с API

Пользователи

Сотрудники (HR)

Группы

Курсы

Доступы и продажи

Отчеты и выгрузки

Кастомные поля

Формы

Нет нужного метода?

Все объекты

Заголовки запроса

Требования к правам доступа

Дерево департаментов

Ответ

Список департаментов

Параметры

Ответ

Создание департамента

Параметры запроса

Обновление департамента

Параметры

Обновление департамента по extId

Параметры

Удаление департамента

Параметры

Ответ

Удаление департамента по extId

Параметры

Ответ

​Заголовки запроса

​Требования к правам доступа

​Дерево департаментов

​Ответ

​Список департаментов

​Параметры

​Ответ

​Создание департамента

​Параметры запроса

​Обновление департамента

​Параметры

​Обновление департамента по extId

​Параметры

​Удаление департамента

​Параметры

​Ответ

​Удаление департамента по extId

​Параметры

​Ответ

Заголовки запроса

Требования к правам доступа

Дерево департаментов

Ответ

Список департаментов

Параметры

Ответ

Создание департамента

Параметры запроса

Обновление департамента

Параметры

Обновление департамента по extId

Параметры

Удаление департамента

Параметры

Ответ

Удаление департамента по extId

Параметры

Ответ