Пользователи
const url = 'https://api-admin.billz.ai/v1/user?page=1&limit=1000&type=-1&force_roles=false';const options = { method: 'GET', headers: { 'platform-id': '7d4a4c38-dd84-4902-b744-0488b80a4c01', Authorization: 'Bearer <token>' }};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api-admin.billz.ai/v1/user?page=1&limit=1000&type=-1&force_roles=false' \ --header 'Authorization: Bearer <token>' \ --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'Коды ошибок: 400 — ошибка валидации входных данных; 401, 403, 429, 500 — общие для всех методов. Форматы тела и семантика — Коды ответов и ошибки.
Authorizations
Заголовок раздела «Authorizations»Parameters
Заголовок раздела «Parameters»Query Parameters
Заголовок раздела «Query Parameters»Не число -> 400. Слишком большое значение — 400, error_code=138
Не число -> 400. Слишком большое значение — 400, error_code=138
Example
1000-1 — все, 1 — обычные, 2 — интеграционные
Ограничена по длине; слишком длинная строка — 400, error_code=139
По умолчанию — активные и приглашённые. Ограничено число элементов
Ограничено число элементов
Ограничено число элементов
Строка true
Возвращать роли для интеграционных пользователей
Применяется только вместе с sort_direction
Asc|desc
Header Parameters
Заголовок раздела «Header Parameters»Идентификатор платформы. Для интеграций используется статичное значение.
Responses
Заголовок раздела «Responses»Успешный ответ
object
object
Отсутствует в ответе, если значение пустое
Отсутствует в ответе, если значение пустое
Отсутствует в ответе, если значение пустое
object
object
object
object
1 обычный, 2 интеграционный
object
Examplegenerated
{ "current_users_count": 1, "blocked_users_count": 1, "deleted_users_count": 1, "count": 1, "users": [ { "id": "example", "external_id": 1, "company_id": "example", "phone_number": "example", "first_name": "example", "last_name": "example", "birth_date": "example", "gender": "example", "mobile_login_allowed": true, "enable_max_validated_devices_limit": true, "max_validated_devices": 1, "status_id": "example", "is_active": true, "image": "example", "image_url": "example", "is_image_avatar": true, "language": "example", "theme": "example", "current_cashbox_id": "example", "current_shop_id": "example", "cashboxes": [ "example" ], "shops": [ { "id": "example", "shop_id": "example", "shop": { "name": "example" } } ], "roles": [ { "id": "example", "role_id": "example", "role": { "name": "example" } } ], "created_at": "example", "updated_at": "example", "deleted_at": 1, "telegram_id": 1, "props_updated": true, "type": 1, "tariff_limits": { "company_tariff": "example", "cashbox_count": 1, "products_count": 1, "users_count": 1, "customers_count": 1 } } ]}