# bot.findLeads()

### Получить лиды по атрибутам

```JavaScript
bot.findLeads($columns = [], $where = [], $orderBy = [], ?int $limit = null, ?int $offset = null)
```

##### Описание:

Находит лида по указанным атрибутам и другим данным.

##### Атрибуты:

<table border="1" id="bkmrk-%D0%98%D0%BC%D1%8F-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-key" style="border-collapse: collapse; width: 100%; height: 428.4px;"><tbody><tr style="height: 29.7875px; background-color: #ced4d9;"><td style="width: 33.3663%; height: 29.7875px;">Имя</td><td style="width: 23.3609%; height: 29.7875px;">Тип</td><td style="width: 43.3717%; height: 29.7875px;">Описание</td></tr><tr style="height: 80px;"><td style="width: 33.3663%; height: 80px;">columns</td><td style="width: 23.3609%; height: 80px;">array</td><td style="width: 43.3717%; height: 80px;">Возвращаемые поля лидов, по умолчанию все поля. Вы можете вывести дополнительные поля: **status\_name**, **channel\_name**, **channel\_code**</td></tr><tr style="height: 77.125px;"><td style="width: 33.3663%; height: 77.125px;">[where](https://docs.metabot24.ru/books/07-spravocnik-po-funkciyam-js/page/where-dlya-botfindleads)</td><td style="width: 23.3609%; height: 77.125px;">array</td><td style="width: 43.3717%; height: 77.125px;">Массив для поиска лидов по атрибутам, статусам и каналам. Подробнее читайте [здесь.](https://docs.metabot24.ru/books/07-spravocnik-po-funkciyam-js/page/where-dlya-botfindleads)

</td></tr><tr style="height: 46.5875px;"><td style="width: 33.3663%; height: 46.5875px;">[orderBy](https://docs.metabot24.ru/books/07-spravocnik-po-funkciyam-js/page/orderby-dlya-botfindleads)</td><td style="width: 23.3609%; height: 46.5875px;">array</td><td style="width: 43.3717%; height: 46.5875px;">Массив сортировки возвращаемых значений. Подробнее читайте [здесь](https://docs.metabot24.ru/books/07-spravocnik-po-funkciyam-js/page/orderby-dlya-botfindleads).</td></tr><tr style="height: 46.4px;"><td style="width: 33.3663%; height: 46.4px;">limit</td><td style="width: 23.3609%; height: 46.4px;">int</td><td style="width: 43.3717%; height: 46.4px;">Максимальное число возвращаемых лидов. Можно вернуть диапазон от 1 до 100</td></tr><tr style="height: 148.5px;"><td style="width: 33.3663%; height: 148.5px;">offset</td><td style="width: 23.3609%; height: 148.5px;">int</td><td style="width: 43.3717%; height: 148.5px;">Числовое значение, указывающее количество записей, которые необходимо пропустить от начала результата выборки перед возвратом данных. Этот параметр используется для пагинации. Например, если `limit` установлен на 100, а `offset` равен 100, то будут возвращены записи, начиная со 101-го лида.</td></tr></tbody></table>

##### Возвращает:

**array** - массив полей лидов.

В массиве следующие поля:

<div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Копировать ссылку" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>- **id** - id лида
- **identification** - внешний id лида
- **manager\_id** - id менеджера привязанного к лиду
- **bot\_id** - id бота лида
- **channel\_id** - id канала лида
- **status\_id** - id статуса лида
- **is\_mute** - включен ли бот для лида

##### Пример:

```JavaScript
let leads = bot.findLeads(
    [],
    [
     ['lead_attributes.attribute_type', 'variable'],
     ['lead_attributes.attribute_key', 'nlpLastIntentName'],
     ['lead_attributes.attribute_value', 'позвать_человека'],
    ],
    [['updated_at']]
);

if (leads.length) {
    let statusName = leads[0].getData('id');
}
```

или получаем поля для первого найденного лида (без условий):

```JavaScript
let leads = bot.findLeads(['status_name', 'channel_name', 'channel_code']);
if (leads.length) {
    let statusName = leads[0].getData('status_name');
    let channelName = leads[0].getData('channel_name');
    let channelCode = leads[0].getData('channel_code');
}
```