Информация о клиентах

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.

Пример ответа:

{
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "avatar": null,
  "full_name": "Иван Иванов",
  "phone_number": "[phone]",
  "external_id": "ext-123",
  "email": "[e-mail]",
  "timezone": "Europe/Moscow",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-06-01T00:00:00Z",
  "attrs": {
    "attr_id": 1,
    "attr_name": "city",
    "attr_label": "Город",
    "attr_type": "string",
    "attr_value": "Москва"
  },
  "tags": ["vip", "активный"],
  "chats": ["uuid-чата-1", "uuid-чата-2"]
}

Ошибки: 401 — ошибка авторизации; 404 — клиент не найден.

Пример запроса:

curl -X GET https://dashboard.fstrk.io/api/partners/profiles/3fa85f64-5717-4562-b3fc-2c963f66afa6/ \
  -H "bot-key: your_bot_key"

---

PUT /api/partners/profiles/{uuid}/

🔒 bot-key или OAuth

Кратко: Обновить данные профиля клиента по UUID.

Параметры пути:

• uuid (string, обязательный) — UUID профиля клиента

Возвращает: 200 OK — обновлённый объект ProfileDetailItem.

Ошибки: 400 — некорректные данные; 401 — ошибка авторизации; 404 — клиент не найден.

Пример запроса:

curl -X PUT https://dashboard.fstrk.io/api/partners/profiles/3fa85f64-5717-4562-b3fc-2c963f66afa6/ \
  -H "Content-Type: application/json" \
  -H "bot-key: your_bot_key" \
  -d '{
    "full_name": "Иван Петров",
    "email": "[e-mail]"
  }'

---

GET /api/partners/profiles/chat/{uuid}/

🔒 bot-key или OAuth

Кратко: Получить информацию о клиенте по UUID чата.

Параметры пути:

• uuid (string, обязательный) — UUID чата

Возвращает: 200 OK — объект ProfileDetailItem.

Ошибки: 401 — ошибка авторизации; 404 — чат не найден.

Пример запроса:

curl -X GET https://dashboard.fstrk.io/api/partners/profiles/chat/3fa85f64-5717-4562-b3fc-2c963f66afa6/ \
  -H "bot-key: your_bot_key"

---

GET /api/partners/profiles/external/{id}/

🔒 bot-key или OAuth

Кратко: Получить информацию о клиенте по внешнему идентификатору.

Параметры пути:

• id (string, обязательный) — внешний идентификатор (только латинские буквы, цифры, -, _)

Возвращает: 200 OK — объект ProfileDetailItem.

Ошибки: 401 — ошибка авторизации; 404 — клиент не найден.

Пример запроса:

curl -X GET https://dashboard.fstrk.io/api/partners/profiles/external/client-123/ \
  -H "bot-key: your_bot_key"

---

PUT /api/partners/profiles/external/{id}/

🔒 bot-key или OAuth

Кратко: Обновить данные профиля клиента по внешнему идентификатору.

Параметры пути:

• id (string, обязательный) — внешний идентификатор

Возвращает: 200 OK — обновлённый объект ProfileDetailItem.

Ошибки: 400 — некорректные данные; 401 — ошибка авторизации; 404 — клиент не найден.

Пример запроса:

curl -X PUT https://dashboard.fstrk.io/api/partners/profiles/external/client-123/ \
  -H "Content-Type: application/json" \
  -H "bot-key: your_bot_key" \
  -d '{
    "full_name": "Иван Иванов",
    "email": "[e-mail]"
  }'

---

GET /api/partners/profiles/phone/{number}/

🔒 bot-key или OAuth

Кратко: Получить информацию о клиенте по номеру телефона.

Параметры пути:

• number (string, обязательный) — номер телефона в международном формате E.164 (например, [phone])

Возвращает: 200 OK — объект ProfileDetailItem.

Ошибки: 401 — ошибка авторизации; 404 — клиент не найден.

Пример запроса:

curl -X GET "https://dashboard.fstrk.io/api/partners/profiles/phone/[phone]/" \
  -H "bot-key: your_bot_key"

---

PUT /api/partners/profiles/phone/{number}/

🔒 bot-key или OAuth

Кратко: Обновить данные клиента по номеру телефона. Если профиль не существует — создаётся новый.

Параметры пути:

• number (string, обязательный) — номер телефона в формате E.164

Возвращает: 200 OK — объект ProfileDetailItem.

Ошибки: 400 — некорректные данные; 401 — ошибка авторизации.

Пример запроса:

curl -X PUT "https://dashboard.fstrk.io/api/partners/profiles/phone/[phone]/" \
  -H "Content-Type: application/json" \
  -H "bot-key: your_bot_key" \
  -d '{
    "full_name": "Новый клиент",
    "email": "[e-mail]"
  }'

---

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:00

• performed_at_to (string, date-time, опциональный) — конец периода, например 2026-06-18T23:59:59+03:00

• type_of (string, опциональный) — тип записи: SANITIZED (очистка данных), PURGED (удаление), MERGED (объединение профилей)

Возвращает: 200 OK — постраничный список объектов CustomerAudit.

Пример ответа:

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customer_uuid": "7ab1c234-5678-4def-a012-3456789bcdef",
      "type_of": "SANITIZED",
      "reason": "Запрос клиента на удаление данных",
      "performed_at": "2026-06-18T12:00:00+03:00",
      "performed_code": "OPERATOR_INSTRUCTION",
      "retention_until": "2027-06-18T12:00:00+03:00",
      "fields": ["phone_number", "email"],
      "attributes": ["city"],
      "tags": ["vip"],
      "chats": ["uuid-чата-1"]
    }
  ]
}

Ошибки: 401 — ошибка авторизации.

Пример запроса:

curl -X GET "https://dashboard.fstrk.io/api/partners/profiles/audit/?type_of=SANITIZED&limit=50" \
  -H "bot-key: your_bot_key"

---

GET /api/partners/profiles/audit/{uuid}/

🔒 bot-key или OAuth

Кратко: Получить конкретную запись журнала аудита по UUID.

Параметры пути:

• uuid (string, обязательный) — UUID записи аудита

Возвращает: 200 OK — объект CustomerAudit.

Ошибки: 401 — ошибка авторизации; 404 — запись не найдена.

Пример запроса:

curl -X GET https://dashboard.fstrk.io/api/partners/profiles/audit/3fa85f64-5717-4562-b3fc-2c963f66afa6/ \
  -H "bot-key: your_bot_key"