API документация

REST API CloseFlow позволяет создавать лиды, управлять автоматизациями и получать уведомления. Все запросы - JSON, аутентификация по JWT (Authorization: Bearer <token>) или X-Api-Key для webhook-эндпоинтов.

Базовый URL

https://api.closeflow.ru

Swagger UI с живыми запросами: /swagger-ui

Аутентификация

Для пользовательского API передавайте JWT в заголовке Authorization. Access-токен действителен 15 минут, refresh-токен - 7 дней. Обновляйте токен через /api/v1/auth/refresh.

Authorization: Bearer eyJhbGciOi...

Для приёма лидов через webhook используйте заголовок X-Api-Key с ключом workspace (создаётся в разделе Настройки).

X-Api-Key: cf_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Формат ответа

Все ответы обёрнуты в конверт со статусом и полезной нагрузкой:

{
  "success": true,
  "data": { "id": "...", "name": "..." },
  "error": null
}

При ошибке success=false, а в error - код и сообщение. Стандартные HTTP-коды: 400, 401, 403, 404, 409, 422, 429, 500.

Эндпоинты

Авторизация

POST/api/v1/auth/register
Создать workspace и пользователя-владельца
POST/api/v1/auth/login
Войти и получить JWT
POST/api/v1/auth/refresh
Обновить access-токен
POST/api/v1/auth/accept-invite
Принять приглашение в workspace

Лиды

GET/api/v1/leads
Список лидов с фильтрами
POST/api/v1/leads
Создать лид вручную
GET/api/v1/leads/{id}
Получить лид
PATCH/api/v1/leads/{id}
Обновить поля лида
PATCH/api/v1/leads/{id}/status
Сменить статус лида
PATCH/api/v1/leads/{id}/assign
Переназначить лид
DELETE/api/v1/leads/{id}
Удалить лид
POST/api/v1/leads/import
Импорт лидов из CSV

Timeline и активности

GET/api/v1/leads/{id}/timeline
История активности лида
POST/api/v1/leads/{id}/timeline
Записать активность (CALL/EMAIL/MEETING/NOTE)
DELETE/api/v1/leads/{leadId}/timeline/{eventId}
Удалить запись активности

Webhook

POST/api/v1/webhook/leads
Приём лидов из внешних форм (требует X-Api-Key)

Workspace и ключи

GET/api/v1/workspaces/current/members
Список участников workspace
POST/api/v1/workspaces/current/invites
Пригласить участника
GET/api/v1/workspaces/current/api-keys
Список API-ключей
POST/api/v1/workspaces/current/api-keys
Создать API-ключ
DELETE/api/v1/workspaces/current/api-keys/{id}
Отозвать API-ключ

Уведомления

GET/api/v1/notifications
Список уведомлений пользователя
PATCH/api/v1/notifications/{id}/read
Отметить уведомление прочитанным
DELETE/api/v1/notifications/{id}
Удалить уведомление
DELETE/api/v1/notifications
Очистить все уведомления

Нужна помощь? Пишите на support@closeflow.ru.