---
title: "Получить формы заявок для сайта"
method: GET
path: "/api/v1/crm/web-forms"
tags: ["CRM leads"]
---

# Получить формы заявок для сайта

`GET /api/v1/crm/web-forms`

## Request

- Base URL: `https://erp.akeda.ru`
- URL: `https://erp.akeda.ru/api/v1/crm/web-forms`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://erp.akeda.ru/oauth2/authorize`, token URL `https://erp.akeda.ru/oauth2/token`, scopes: `akeda:delegate`)

Формы заявок кабинета для вставки на сайт: куда падает заявка (лид или сделка с воронкой и этапом), источник, ответственный, поля, тексты, разрешённые сайты, ключ публичного адреса public_key и сводка журнала — число созданных заявок за сутки и время последней. Настраивает администратор CRM.

## Headers

- `X-Tenant` string, required

## Response `200`

Формы кабинета

- CRMWebFormList
  - `forms` CRMWebForm[], required
    - `id` string, uuid, required
    - `name` string, required
    - `is_active` boolean, required: Выключенная форма заявок не принимает
    - `target` 'lead' | 'deal', required: Что создаёт заявка: лид или сделку
    - `client_kind` 'person' | 'company' | 'choice', required: Кто оставляет заявку: person — частное лицо (клиент-человек по телефону, затем почте, или новый); company — компания (по ИНН, без ИНН — по названию, или новая) и её контактное лицо, связанное с ней, лид или сделка — на компании; choice — посетитель выбирает на форме
    - `contact_label` string, required: Подпись поля имени, когда заявку оставляет компания («Контактное лицо»); пусто — подпись поля как есть
    - `pipeline_id` string, uuid, nullable, required: Воронка сделки; пусто у лида. Воронку удалили — заявки идут лидами
    - `stage_id` string, uuid, nullable, required: Открытый этап, на который встаёт сделка заявки
    - `source` string, required: Код источника из справочника источников обращения: им помечается лид или сделка
    - `owner_id` integer, nullable, required: Ответственный заявок; пусто — создатель формы
    - `fields` CRMWebFormField[], required
      - `key` 'name' | 'phone' | 'email' | 'company' | 'inn' | 'comment', required: Куда ложится значение: имя и компания — в клиента, ИНН — поиск компании без дублей, телефон и почта — в каналы клиента, комментарий — в слова клиента лида или сделки. Компания и ИНН есть только у заявки от компании
      - `label` string, required: Подпись поля на сайте; текст кабинета, не переводится
      - `required` boolean, required: Заявка без значения поля отклоняется. Единственный способ связи на форме (только телефон или только почта) обязателен всегда; телефон и почта вместе — нужен хотя бы один
    - `title` string, required: Заголовок над формой
    - `button_text` string, required
    - `success_message` string, required: Что увидит посетитель после отправки
    - `consent_required` boolean, required: Спрашивать согласие на обработку персональных данных
    - `consent_text` string, required
    - `consent_url` string, required: Ссылка на документ согласия на сайте клиента; прикреплённый файл главнее
    - `consent_link_text` string, required: Слова ссылки на документ рядом с галочкой согласия
    - `consent_file` CRMWebFormConsentFile, required: Прикреплённый к форме документ согласия
      - `id` string, uuid, required
      - `name` string, required
      - `mime_type` string, required
      - `size_bytes` integer, required
      - `scan_status` 'clean' | 'skipped' | 'pending' | 'infected', required: clean и skipped — показывается посетителям; pending — антивирус проверяет; infected — заражён и не показывается
      - `uploaded_at` string, date-time, required
    - `allowed_origins` string[], required: Сайты, с которых принимаются заявки (https://site.ru); пусто — любой сайт
    - `created_by` integer, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `public_key` string, required: Ключ публичного адреса: /api/v1/crm/public/forms/{public_key}. Не секрет — он стоит в коде сайта
    - `last_submitted_at` string, date-time, nullable, required: Когда форма последний раз создала лид или сделку
    - `submissions_24h` integer, required: Сколько лидов и сделок форма создала за сутки

## Other responses

- `401`: Сессия, ключ или кабинет не подтверждены
- `403`: Текущая роль не имеет требуемого права

---

[API](https://skmtc.dev/akeda/apis/akeda-erp-client-api.md) · [All operations](https://skmtc.dev/akeda/apis/akeda-erp-client-api/llms.txt) · [OpenAPI document](https://skmtc.dev/akeda/apis/akeda-erp-client-api/revisions/3c60ded179f2?raw)