Тип запроса query
.
Возращает данные о клиентах.
Параметры запроса
Запрос отправляется без параметров, необоходимые данные содержит access_token
, передаваемый в хедере запроса.
Запрос содержит тело ответа с набором запрашиваемых параметров о пользователях.
Пример запроса
query clients {
clients{
data{
id
uuid
group{
title
}
nickname
dob
roles{
alias
}
creator{
id
}
login
phone
email
phone_suffix
country_code
first_name
last_name
middle_name
deposit
last_client_activity
last_worker_activity
last_comment{
id
}
user_discount
created_at
updated_at
disabled_at
banned_at
total_hours
pausable_info{
tariff{
id
}
}
city
avatar_url
roles{
alias
}
}
total_deposits
paginatorInfo{
count
total
}
}
}
Пример ответа
{
"data": {
"clients": {
"data": [
{
"id": 1041144,
"uuid": "0b319e3b-c228-4337-bcd4-dbb9f9590dd5",
"group": {
"title": "Black"
},
"nickname": "Wind-TestDePo",
"dob": "2000-01-01",
"roles": [],
"creator": null,
"login": "79555555556",
"phone": "79555555556",
"email": "example@yandex.ru",
"phone_suffix": "5556",
"country_code": "RU",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"deposit": 100,
"last_client_activity": "2023-08-10 11:20:12",
"last_worker_activity": null,
"last_comment": null,
"user_discount": 0,
"created_at": "2023-08-10 11:18:53",
"updated_at": "2023-08-10 11:20:12",
"disabled_at": null,
"banned_at": null,
"total_hours": 0,
"pausable_info": null,
"city": null,
"avatar_url": ""
}
],
"total_deposits": 40920.69921875,
"paginatorInfo": {
"count": 8,
"total": 8
}
}
}
}
Параметры ответа
В ответе возвращаются запрошенные параметры по каждому пользователю и сумма общего депозита.
Параметр | Тип данных | Описание | Обязательно | Пример |
---|---|---|---|---|
data |
Array | данные о пользователях клиента | + | User |
total_deposits |
float | Общий депозит | - | 40920.69921875 |