Информация о клиентах
GET /api/partners/profiles/
🔒 bot-key или OAuth
Кратко: Получить список клиентов.
Параметры запроса:
limit(integer, опциональный) — кол-во элементов на странице (макс. 100)offset(integer, опциональный) — кол-во элементов для пропуска
Возвращает: 200 OK — постраничный список объектов ProfileListItem: uuid, full_name, phone_number, external_id, email, timezone, created_at, updated_at.
Ошибки: 401 — ошибка авторизации.
Пример запроса:
curl -X GET "https://dashboard.fstrk.io/api/partners/profiles/?limit=100" \
-H "bot-key: your_bot_key"GET /api/partners/profiles/{uuid}/
🔒 bot-key или OAuth
Кратко: Получить информацию о клиенте по UUID профиля.
Параметры пути:
uuid(string, обязательный) — UUID профиля клиента
Возвращает: 200 OK — объект ProfileDetailItem.
Ошибки: 401 — ошибка авторизации; 404 — клиент не найден.
Пример запроса:
PUT /api/partners/profiles/{uuid}/
🔒 bot-key или OAuth
Кратко: Обновить данные профиля клиента по UUID.
Параметры пути:
uuid(string, обязательный) — UUID профиля клиента
Возвращает: 200 OK — обновлённый объект ProfileDetailItem.
Ошибки: 400 — некорректные данные; 401 — ошибка авторизации; 404 — клиент не найден.
Пример запроса:
GET /api/partners/profiles/chat/{uuid}/
🔒 bot-key или OAuth
Кратко: Получить информацию о клиенте по UUID чата.
Параметры пути:
uuid(string, обязательный) — UUID чата
Возвращает: 200 OK — объект ProfileDetailItem.
Ошибки: 401 — ошибка авторизации; 404 — чат не найден.
Пример запроса:
GET /api/partners/profiles/external/{id}/
🔒 bot-key или OAuth
Кратко: Получить информацию о клиенте по внешнему идентификатору.
Параметры пути:
id(string, обязательный) — внешний идентификатор (только латинские буквы, цифры,-,_)
Возвращает: 200 OK — объект ProfileDetailItem.
Ошибки: 401 — ошибка авторизации; 404 — клиент не найден.
Пример запроса:
PUT /api/partners/profiles/external/{id}/
🔒 bot-key или OAuth
Кратко: Обновить данные профиля клиента по внешнему идентификатору.
Параметры пути:
id(string, обязательный) — внешний идентификатор
Возвращает: 200 OK — обновлённый объект ProfileDetailItem.
Ошибки: 400 — некорректные данные; 401 — ошибка авторизации; 404 — клиент не найден.
Пример запроса:
GET /api/partners/profiles/phone/{number}/
🔒 bot-key или OAuth
Кратко: Получить информацию о клиенте по номеру телефона.
Параметры пути:
number(string, обязательный) — номер телефона в международном формате E.164 (например,+79001234567)
Возвращает: 200 OK — объект ProfileDetailItem.
Ошибки: 401 — ошибка авторизации; 404 — клиент не найден.
Пример запроса:
PUT /api/partners/profiles/phone/{number}/
🔒 bot-key или OAuth
Кратко: Обновить данные клиента по номеру телефона. Если профиль не существует — создаётся новый.
Параметры пути:
number(string, обязательный) — номер телефона в формате E.164
Возвращает: 200 OK — объект ProfileDetailItem.
Ошибки: 400 — некорректные данные; 401 — ошибка авторизации.
Пример запроса:
GET /api/partners/profiles/audit/
🔒 bot-key или OAuth
Кратко: Получить список записей журнала аудита профилей клиентов.
Параметры запроса:
limit(integer, опциональный) — кол-во элементов на странице (макс. 100)offset(integer, опциональный) — кол-во элементов для пропускаperformed_at_from(string, date-time, опциональный) — начало периода, например2026-06-18T00:00:00+03:00performed_at_to(string, date-time, опциональный) — конец периода, например2026-06-18T23:59:59+03:00type_of(string, опциональный) — тип записи:SANITIZED(очистка данных),PURGED(удаление),MERGED(объединение профилей)
Возвращает: 200 OK — постраничный список объектов CustomerAudit.
Ошибки: 401 — ошибка авторизации.
Пример запроса:
GET /api/partners/profiles/audit/{uuid}/
🔒 bot-key или OAuth
Кратко: Получить конкретную запись журнала аудита по UUID.
Параметры пути:
uuid(string, обязательный) — UUID записи аудита
Возвращает: 200 OK — объект CustomerAudit.
Ошибки: 401 — ошибка авторизации; 404 — запись не найдена.
Пример запроса:
Last updated