CRM ліди

Отримання всіх лідів

Метод дозволяє отримати список усіх лідів.

Метод: GET

URL

https://{API_ENDPOINT}:8443/ics3/rest/crm/lead

Приклад запиту

curl -X GET \
  "https://{API_ENDPOINT}:8443/ics3/rest/crm/lead" \
  -H "Authorization: Bearer {TOKEN}"

Фільтрування лідів

Метод дозволяє отримати ліди з CRM IPTel з можливістю фільтрації, сортування та пагінації. Тип запиту визначається змінною requestType: "all" – всі ліди, "my" – ліди користувача, токен якого використовується
Метод: GET

Query                                                                                                                                                                                                                        

Назва параметра Доступні значення (тип) Примітки
ids number[] Список ID потрібних лідів
companyName string Назва компанії
position string Посада
email string Email
firstName string Ім’я 
fromDateTimeCreated string Дата створення від
toDateTimeCreated string Дата створення до
fromDateTimeModified string Дата модифікації від
toDateTimeModified string Дата модифікації до
lastName string Прізвище ліда
name string Назва ліда
pipelineId number ID воронки
phaseIds number[] Список ID фаз воронки
phoneNumber string Номер телефону
responsibleId number ID відповідального користувача
sourceId number ID джерела
telegramUsername string Telegram нік користувача
additionalFields AdditionalFieldFilterData[] Додаткові поля з оператором та значенням. Приклад: &af12<100 – фільтрація по додатковому полю з id=2, при значення більшому 100
phaseLimit number Максимальна кількість лідів у кожній воронці
additionalFieldsId string[] ID додаткових полів
dialerCampaignsIds string[] ID кампаній автообдзвону
tags number[] Список ID тегів
externalId string Зовнішній ID ліда
pageSize number Максимальна кількість лідів
start number Початковий індекс для пагінації
sortByField string Назва поля ліда, яке використовується для сортування
sortingOrder "ASC" | "DESC" Порядок сортування

URL

https://{API_ENDPOINT}:8443/ics3/rest/crm/lead/filter/{requestType}?{query_params}

Приклад запиту

curl -X GET \
  "https://{API_ENDPOINT}:8443/ics3/rest//crm/lead/filter/all?pageSize=50&start=0&sortByField=name&sortingOrder=ASC&companyName=Example" \
  -H "Authorization: Bearer {TOKEN}"