Список команд

POST https://gptunnel.ru/api/v1/employees/getTeams

Возвращает команды организации с пагинацией (по 25 на страницу). Для каждой команды отдаётся список id её участников. Можно отфильтровать выборку по конкретным id команд.

Headers

Параметр	Тип	Описание
`Authorization`*	`string`	API ключ

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

Параметр	Тип	Описание
`page`	`number`	Номер страницы (с 1, по умолчанию 1)
`teamIds`	`string[]`	Фильтр по id команд (массив от 1 до 25). Если не передан — все команды

Схема успешного ответа (200 OK)

Ответ

Параметр	Тип	Описание
`code`*	`number`	Код результата (0 — успех)
`items`*	`Team[]`	Команды текущей страницы (см. Team ниже)
`page`*	`number`	Номер текущей страницы
`pageSize`*	`number`	Лимит команд на странице (25) — максимальный размер страницы
`count`*	`number`	Сколько команд реально на текущей странице (≤ pageSize; на последней странице меньше)
`total`*	`number`	Всего команд под фильтр (по всем страницам)
`totalPages`*	`number`	Всего страниц

Team

Параметр	Тип	Описание
`teamId`*	`string`	id команды
`teamName`*	`string`	Название команды
`userIds`*	`string[]`	id участников команды (может быть пустым массивом)

Пример запроса

curl --request POST \
  --url https://gptunnel.ru/api/v1/employees/getTeams \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{ "page": 1 }'

import axios from 'axios'

const response = await axios({
  method: 'POST',
  url: 'https://gptunnel.ru/api/v1/employees/getTeams',
  headers: {
    Authorization: 'YOUR_API_KEY',
  },
  data: {
    page: 1,
  },
})

console.log(response.data)

import requests

response = requests.post(
    'https://gptunnel.ru/api/v1/employees/getTeams',
    headers={'Authorization': 'YOUR_API_KEY'},
    json={
        'page': 1,
    },
)

print(response.json())

Пример ответа

{
  "code": 0,
  "items": [
    {
      "teamId": "66a346f64dcb57627c03d596",
      "teamName": "Маркетинг",
      "userIds": ["66b1...", "66b2..."]
    },
    {
      "teamId": "5f1c9a0b2e3d4c5a6b7c8d9e",
      "teamName": "Продажи",
      "userIds": []
    }
  ],
  "page": 1,
  "pageSize": 25,
  "count": 2,
  "total": 2,
  "totalPages": 1
}

{
  "code": 3,
  "message": "Invalid input, check schema issues.",
  "details": []
}

{
  "error": {
    "message": "Unauthorized",
    "type": "unauthorized_request_error",
    "param": null,
    "code": null
  }
}

{
  "code": 7,
  "message": "Not allowed to perform this action for the organization."
}

{
  "code": 13,
  "message": "Employee management is not available from a personal account. Use a business organization API key."
}

{
  "code": 1,
  "message": "Internal server error.",
  "trace_id": "66a346f64dcb57627c03d596"
}