Skip to content

Получить уникальных авторизованных получателей, включая отклонённые попытки

Request

Требуется право CLIENT_INVITATIONS_VIEW. Для каждого целевого бизнеса и устойчивой идентичности клиента возвращается один элемент, даже после повторных переходов, входов или пересоздания аккаунта. Отклонённая попытка клиента, привязанного к другому бизнесу, включается со значениями FAILED и ALREADY_BOUND_TO_OTHER_BUSINESS, но другой бизнес не раскрывается. status и binding_status — независимые фильтры, объединяемые через AND. По умолчанию записи сортируются по first_seen_at, затем invitation_id по убыванию. Поиск выполняется только по имени и телефону, доступным бизнесу согласно правилам доступа. У клиента без записи record=null; услуга и цена не подставляются.

Security
bearerAuth or jwtCookie
Query
offsetinteger, >= 0
Default:0
limitinteger, [ 1 .. 200 ]
Default:100
statusstring(BciQualificationStatus)

WAITING_FOR_VISIT означает ожидание фактического визита без активной подходящей записи. BOOKED означает наличие записи к пригласившему бизнесу, но оказание услуги ещё не подтверждено. QUALIFIED является историческим статусом и сохраняется после отвязки. FAILED включает отклонённые авторизованные попытки и окончательную потерю права участия.

Enum:"WAITING_FOR_VISIT""BOOKED""QUALIFIED""FAILED"
binding_statusstring(BciBindingStatus)

В DTO для бизнеса статус указан относительно целевого бизнеса. У клиента, привязанного к другому бизнесу, здесь будет NONE вместе с ALREADY_BOUND_TO_OTHER_BUSINESS; ID привязки, карточка и даты другого бизнеса не раскрываются.

Enum:"NONE""ACTIVE""DETACHED"
searchstring, <= 100 characters
curl -i -X GET \
  'https://felmee.com/api/business-client-invitations/clients?offset=0&limit=100&status=WAITING_FOR_VISIT&binding_status=NONE&search=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Страница отфильтрованных уникальных получателей

Bodyapplication/json
successbooleanrequired
Value:true
messagestringrequired
codeErrorstring or nullrequired

Поле для обратной совместимости; совпадает с error_code.

error_codestring or nullrequired

Ошибка транспорта или валидации в lower_snake_case; при успешной обработке — null.

dataobject or null(BciInvitedClientPage)required
Response
{
  "success": true,
  "message": "string",
  "codeError": "string",
  "error_code": "string",
  "data": {
    "items": [ … ],
    "offset": 0,
    "limit": 1,
    "has_more": true,
    "total_count": 0
  }
}