Перейти к содержимому

Список пользователей

GET
/users
curl --request GET \
--url 'https://app.mybi.ru/api/v2/users?page=1&length=10&id=1%2C2%2C3&created_from=2026-01-01%2000%3A00%3A00&created_to=2026-01-01%2023%3A59%3A59&modified_from=2026-01-01%2000%3A00%3A00&modified_to=2026-01-01%2023%3A59%3A59&token=<token>'

Возвращает список пользователей. Обычный пользователь видит только свою учётную запись; администратор — пользователей своей группы. Результат разбит на страницы (поле pagination), доступны фильтры по идентификаторам и датам.

page
integer
по умолчанию: 1 >= 1

Текущая страница

Пример

1
length
integer
по умолчанию: 100 >= 1 <= 500

Количество записей на странице

Пример

10
id
Array<integer>
>= 1 элементов <= 500 элементов уникальные элементы

Идентификаторы записей через запятую, не более 500

Пример

?id=1%2C2%2C3
created_from
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

Дата создания с, формат YYYY-MM-DD HH:MM:SS

Пример

2026-01-01 00:00:00
created_to
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

Дата создания по, формат YYYY-MM-DD HH:MM:SS

Пример

2026-01-01 23:59:59
modified_from
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

Дата изменения с, формат YYYY-MM-DD HH:MM:SS

Пример

2026-01-01 00:00:00
modified_to
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

Дата изменения по, формат YYYY-MM-DD HH:MM:SS

Пример

2026-01-01 23:59:59

Список пользователей успешно получен

MIME-типapplication/json
object
users

Список пользователей

Array<object>

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

object
id

Идентификатор пользователя

integer
first_name

Имя

string
last_name

Фамилия

string
company

Компания

string
activity

Деятельность

string
email

Электронная почта

string
extra_emails

Дополнительная электронная почта

string
phone_number

Телефон

string
timezone

Часовой пояс

string
balance

Баланс

number формат: double
stage

Этап

string
Допустимые значения: проекты удалены регистрация зашел в сервис создал проект пробовал подключить подключил источник ввел IP скачал модель завершился триал оплата повторная оплата
plan

Тариф

object
id

Идентификатор тарифа

integer
rows

Количество строк

integer
duration

Продолжительность загрузок

integer
cost

Стоимость

number формат: double
extended

Расширенный

boolean
options

Параметры

object
count

Количество проектов

integer
size

Объем базы данных

integer
rows

Строк израсходовано

integer
last_payday

Дата последней оплаты

string формат: date
next_payday

Дата следующей оплаты

string формат: date
blocked_date

Дата блокировки

string формат: date-time
suspended_date

Дата приостановки

string формат: date-time
duration

Продолжительность загрузок

integer
autopay

Автоплатеж

boolean
created_date

Дата создания

string формат: date-time
modified_date

Дата изменения

string формат: date-time
pagination

Параметры постраничной выдачи

object
page
обязательный

Номер текущей страницы (нумерация с 1)

integer
has_next

Есть ли следующая страница

boolean
has_prev

Есть ли предыдущая страница

boolean
fact_length

Сколько записей возвращено на этой странице

integer
length
обязательный

Запрошенный размер страницы

integer
total
обязательный

Всего записей по заданному фильтру

integer

Пример

{
"users": [
{
"stage": "проекты удалены"
}
],
"pagination": {
"page": 1,
"has_next": true,
"has_prev": true,
"fact_length": 10,
"length": 10,
"total": 5000
}
}

Ошибка авторизации

MIME-типapplication/json
object
status

Код ошибки

integer
error

Текст ошибки

string

Пример сгенерировано

{
"status": 1,
"error": "example"
}