Документация → Гости
Гости
Поиск гостя по телефону, гость по id и постраничная выгрузка базы.
Гости ресторана: поиск по телефону, гость по id и выгрузка всей базы.
Сумма и даты пересчитываются из заказов CRM ресторана (iiko, Goulash, Frontpad) после синка — с задержкой до часа после заказа. Подменные номера агрегаторов (не телефон гостя) в API не попадают.
Синхронизация: пройдите все страницы GET /v1/guests, сохраните updated_at последней
записи, а в следующий раз зовите с updated_after — придут только изменившиеся гости.
Объект guest
Гость ресторана
| Поле | Тип | Описание |
|---|---|---|
id | string | Неизменный непрозрачный id |
object | string | Тип объекта |
phone | string | null | Телефон в E.164; null — телефон неизвестен |
name | string | null | Имя из CRM ресторана; null — нет |
orders_count | integer | Заказов за всю историю |
total_spent | money | Сумма заказов за всю историю |
first_order_date | date | null | Бизнес-дата первого заказа в поясе ресторана |
last_order_date | date | null | Бизнес-дата последнего заказа в поясе ресторана |
segment_ids | string[] | Сегменты, в которых гость сейчас; может быть пустым |
sms_opt_out | boolean | Гость отписался от SMS — рассылки до него не дойдут |
updated_at | datetime | UTC; меняется при любом изменении полей выше |
{
"id": "gst_7Hq2kP9x",
"object": "guest",
"phone": "+79001234567",
"name": "Анна",
"orders_count": 14,
"total_spent": {
"amount": "15400.00",
"currency": "RUB"
},
"first_order_date": "2025-03-02",
"last_order_date": "2026-10-12",
"segment_ids": [
"seg_loyal"
],
"sms_opt_out": false,
"updated_at": "2026-10-13T21:04:11Z"
}Выгрузить базу гостей
GET /v1/guests · право guests:read
Вся база постранично в порядке updated_at, id. Для синка сохраните updated_at последней
записи и зовите с updated_after. Платная опция «Выгрузка базы по API» — подключается у
менеджера LazyCRM; без неё 403 paid_feature_required, а найти одного гостя можно через
GET /v1/guests/lookup.
| Параметр | Где | Обязателен | Описание | Пример |
|---|---|---|---|---|
updated_after | query | Только гости, изменённые позже этого момента (RFC 3339 с поясом) | 2026-10-13T00:00:00Z | |
segment_id | query | Только гости этого сегмента | seg_loyal | |
limit | query | Размер страницы, от 1 до 100 | 100 | |
cursor | query | next_cursor предыдущей страницы; привязан к фильтрам запроса | c_eyJ2IjpbIjIwMjYtMTAtMTMiXX0 |
curl https://app.lazycrm.ru/v1/guests \
-H "Authorization: Bearer lcrm_live_…"Ошибки: 400 unknown_parameter, 400 invalid_cursor, 401 missing_api_key, 401 invalid_api_key, 403 insufficient_scope, 403 paid_feature_required, 422 validation_error, 429 rate_limited, 500 internal_error, 503 upstream_unavailable.
Найти гостя по телефону
GET /v1/guests/lookup · право guests:read
Один гость по номеру телефона, например на оформлении заказа. Входит в базовый доступ.
Нет гостя — 404 not_found, кривой номер — 422 validation_error с причиной invalid_phone.
Пример: GET /v1/guests/lookup?phone=%2B79001234567.
| Параметр | Где | Обязателен | Описание | Пример |
|---|---|---|---|---|
phone | query | да | Телефон гостя, лучше в E.164 | +79001234567 |
curl "https://app.lazycrm.ru/v1/guests/lookup?phone=%2B79001234567" \
-H "Authorization: Bearer lcrm_live_…"Ошибки: 400 unknown_parameter, 401 missing_api_key, 401 invalid_api_key, 403 insufficient_scope, 404 not_found, 422 validation_error, 429 rate_limited, 500 internal_error, 503 upstream_unavailable.
Получить гостя
GET /v1/guests/{guest_id} · право guests:read
Один гость по id из выгрузки или поиска. Гость другого ресторана — 404.
| Параметр | Где | Обязателен | Описание | Пример |
|---|---|---|---|---|
guest_id | путь | да | Id гостя | gst_7Hq2kP9x |
curl https://app.lazycrm.ru/v1/guests/gst_7Hq2kP9x \
-H "Authorization: Bearer lcrm_live_…"Ошибки: 400 unknown_parameter, 401 missing_api_key, 401 invalid_api_key, 403 insufficient_scope, 404 not_found, 429 rate_limited, 500 internal_error, 503 upstream_unavailable.
