Получение списка клиентов
GET
/v1/client
const url = 'https://api-admin.billz.ai/v1/client?page=1&limit=10';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/client?page=1&limit=10' \ --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»page
integer format: int32
Номер страницы
limit
integer format: int32
Размер страницы
phone_number
string
Точный телефон
chat_id
string
Telegram chat_id
search
string
Строка поиска
Header Parameters
Заголовок раздела «Header Parameters»platform-id
string
Идентификатор платформы. Для интеграций используется статичное значение.
Responses
Заголовок раздела «Responses»Успешный ответ
Media typeapplication/json
object
count
Общее количество найденных клиентов
integer format: int32
clients
Список клиентов
Array<object>
object
id
ID клиента
string format: uuid
external_id
Внешний (порядковый) идентификатор
string
first_name
Имя
string
last_name
Фамилия
string
middle_name
Отчество
string
created_at
Дата создания
string
birth_date
Дата рождения
string
first_transaction_date
Дата первой транзакции
string
last_transaction_date
Дата последней транзакции
string
balance
Кешбэк-баланс
number format: double
cards
Коды карт
Array<string>
company_name
Название компании
string
chat_id
Telegram chat_id; при пустом значении поле в ответе отсутствует
string
phone_numbers
Телефоны
Array<string>
gender
Пол: male, female или пустая строка
string
Examplegenerated
{ "count": 1, "clients": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "external_id": "example", "first_name": "example", "last_name": "example", "middle_name": "example", "created_at": "example", "birth_date": "example", "first_transaction_date": "example", "last_transaction_date": "example", "balance": 1, "cards": [ "example" ], "company_name": "example", "chat_id": "example", "phone_numbers": [ "example" ], "gender": "example" } ]}