Аккаунт

Данные тарифа, список воркспейсов и папок текущего пользователя

Аккаунт

Эндпоинты аккаунта позволяют получить информацию о текущем тарифном плане, список доступных воркспейсов и структуру папок. Все запросы требуют авторизации через Authorization: Bearer YOUR_API_TOKEN.

Скачайте markdown‑версию раздела «Аккаунт» для использования в ChatGPT / других LLM:

/static/api/account.md
AI Markdown

Информация о тарифе GET /api/v3/service/tariff

Возвращает данные о текущем тарифном плане пользователя: код тарифа, название и количество оставшихся дней.

Ответ

Поле Тип Описание
tariff.code string Код тарифа (например, free, pro)
tariff.name string Отображаемое название тарифа
tariff.days_left integer|null Количество оставшихся дней тарифа; null для бессрочных планов
GET /api/v3/service/tariff 
curl -X GET "https://api.webask.io/api/v3/service/tariff" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

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

{
  "tariff": {
    "code": "pro",
    "name": "Pro",
    "days_left": 24
  }
}

Список воркспейсов GET /api/v3/service/workspaces

Возвращает пагинированный список воркспейсов, доступных текущему пользователю, с указанием роли и тарифа каждого воркспейса.

Query-параметры

Параметр Тип По умолчанию Описание
page integer 1 Номер страницы
per_page integer 20 Количество воркспейсов на странице

Поля ответа (элемент массива)

Поле Тип Описание
id integer ID воркспейса
name string Название воркспейса
role string Роль текущего пользователя (owner, admin, member)
tariff string Код тарифа воркспейса

Ответ также содержит стандартные поля пагинации: total, current_page, last_page, per_page.

GET /api/v3/service/workspaces 
curl -X GET "https://api.webask.io/api/v3/service/workspaces?page=1&per_page=20" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

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

{
  "data": [
    {
      "id": 1,
      "name": "Мой воркспейс",
      "role": "owner",
      "tariff": "pro"
    },
    {
      "id": 7,
      "name": "Командный проект",
      "role": "member",
      "tariff": "business"
    }
  ],
  "total": 2,
  "current_page": 1,
  "last_page": 1,
  "per_page": 20
}

Список папок GET /api/v3/service/folders

Возвращает плоский список всех папок текущего пользователя, включая папку по умолчанию. Папки используются для организации опросов внутри воркспейса.

Поля ответа (элемент массива)

Поле Тип Описание
id integer ID папки
name string Название папки
is_default boolean true — папка по умолчанию (новые опросы без указания папки попадают сюда)
pos integer Позиция папки в списке для сортировки
GET /api/v3/service/folders 
curl -X GET "https://api.webask.io/api/v3/service/folders" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

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

[
  {
    "id": 1,
    "name": "Общие",
    "is_default": true,
    "pos": 0
  },
  {
    "id": 5,
    "name": "Маркетинг",
    "is_default": false,
    "pos": 1
  },
  {
    "id": 8,
    "name": "HR",
    "is_default": false,
    "pos": 2
  }
]