CRM leads

Получить лиды

Возвращает лиды CRM. Отбор по дополнительным полям: параметры cf.<ключ поля>=<значение>, до 10 полей. Число и флажок сравниваются по типу поля, вариант справочника - по идентификатору записи, текст - по подстроке без учёта регистра; поле, которого нет, отбирает ноль записей.

get/api/v1/crm/leads

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/crm/leads
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key
    • OAuth 2 (authorization code, authorization URL https://erp.akeda.ru/oauth2/authorize, token URL https://erp.akeda.ru/oauth2/token, scopes: akeda:delegate)

Query parameters

qstring

Поиск по названию и описанию

status'new' | 'qualified' | 'disqualified' | 'converted'

Единственный статус лида. Вычисляется из смысла этапа лида (CRMLeadStageMeaning) и напрямую не правится: меняется переносом на этап, квалификацией, отказом или конвертацией

Статус лида

ownerinteger

Ответственный сотрудник

customerstring uuid

Клиент CRM

stagestring uuid

Этап доски приёма лидов

sourcestring

Канал обращения лида: точное значение или канал целиком (site находит и site:akeda.ru)

archivedboolean

Показать архивные записи вместо активных

sort'updated_desc' | 'created_asc'

Порядок лидов: updated_desc - свежие правки сверху (по умолчанию), created_asc - сначала давние обращения

limitinteger

Размер страницы

offsetinteger

Смещение страницы

Headers

X-Tenantstring required

Slug выбранного кабинета; кабинет не является юрлицом

Response

Лиды кабинета с именем клиента и ответственного

idstring uuid required
titlestring required
amountstring

Сумма лида десятичной строкой: «19990.50»; переходит в сделку при конвертации

currencystring

Код валюты из справочника ERP; пусто — валюта не выбрана

sourcestring required

Канал обращения; по нему собирается аналитика источников

descriptionstring required

Заметка менеджера о заявке

first_messagestring required

Что написал или сказал клиент - слова самого обращения, а не пересказ

contact_handlestring required

Ник, номер или адрес в канале, пока карточка клиента не заведена

reference_idstring uuid
owner_idinteger
stage_idstring uuid
crm_customer_idstring uuid
next_actionstring required
next_action_atstring date-time
archived_atstring date-time
status'new' | 'qualified' | 'disqualified' | 'converted' required

Единственный статус лида. Вычисляется из смысла этапа лида (CRMLeadStageMeaning) и напрямую не правится: меняется переносом на этап, квалификацией, отказом или конвертацией

qualification_reasonstring
reject_reason_idstring uuid
converted_deal_idstring uuid
merged_into_lead_idstring uuid
utm_sourcestring
utm_mediumstring
utm_campaignstring
utm_termstring
utm_contentstring
landing_pagestring
referrerstring
customobject nullable

Дополнительные поля кабинета: состав задаёт «Настройки → Поля»

created_atstring date-time required
updated_atstring date-time required
customer_namestring
customer_phonestring
customer_messengersobject nullable
owner_namestring
reject_reasonstring

Changes

No recorded changes to this operation across all 1 revision of this API.