Skip to content

Админ-панель — клиенты

Просмотр, изменение, блокировка и статистика клиентов.

Operations

Получить список клиентов с пагинацией

Request

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

Security
bearerAuth or jwtCookie
Query
fromstring, (date)required

Начало периода включительно

tostring, (date)required

Конец периода включительно

querystring, <= 200 characters
cityArray of strings, <= 50 items

Фильтр по городам. Параметр можно передать несколько раз; клиент попадёт в результат, если его город совпадает хотя бы с одним из выбранных городов.

Example:city=Москва&city=Санкт-Петербург
statusArray of strings, <= 3 items, unique
Items Enum:"ACTIVE""INACTIVE""BLOCKED"
offsetinteger, >= 0
Default:0
limitinteger, [ 1 .. 100 ]
Default:20
sortArray of strings, <= 3 items

Повторяемый параметр сортировки, например registered_at:desc.

curl -i -X GET \
  'https://felmee.com/api/admin/clients?from=2019-08-24&to=2019-08-24&query=string&city=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0%2C%D0%A1%D0%B0%D0%BD%D0%BA%D1%82-%D0%9F%D0%B5%D1%82%D0%B5%D1%80%D0%B1%D1%83%D1%80%D0%B3&status=ACTIVE&offset=0&limit=20&sort=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Список клиентов

Bodyapplication/json
codeErrorstring or nullrequired

Устаревший camelCase-alias поля error_code; при ошибке оба поля содержат одинаковое значение.

successbooleanrequired

Флаг успешного выполнения запроса

messagestringrequired

Человекочитаемое описание результата

error_codestring or null(ERROR_CODE)required

Код ошибки. Для успешных ответов всегда null.

Enum:"invalid_body""unauthorized""not_found""conflict""object_modified_by_another_thread""action_too_late""too_many_request""code_is_gone""forbidden""user_blocked"
dataobject or null(AdminClientListData)required

Полезная нагрузка. Может быть объектом, массивом или null.

Response
{
  "success": true,
  "message": "Clients retrieved successfully",
  "codeError": null,
  "error_code": null,
  "data": {
    "period": { … },
    "items": [ … ],
    "offset": 0,
    "limit": 20,
    "has_more": false
  }
}