## Список лидов

`GET /v1/leads`

Возвращает список лидов с поддержкой фильтрации, сортировки и авто-пагинации.

## Параметры

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `limit` | number | `50` | Количество записей (до 5000). При `limit > 50` авто-пагинация |
| `offset` | number | `0` | Пропустить N записей. При `offset > 0` рекомендуется `limit <= 500`. Для обхода всей коллекции дешевле курсор — `order[id]=asc` и `filter[>id]` из `meta.nextAfterId` |
| `select` | string | — | Выборка полей: `?select=id,title,stageId,amount`. Неизвестные поля игнорируются |
| `order` | object | — | Сортировка: `?order[createdTime]=desc`. Имена для сортировки — из `GET /v1/leads/fields` |
| `filter` | object | — | Фильтрация по полям `GET /v1/leads/fields`.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[stageId]=NEW` |
| `withTotal` | string | — | Нужно ли количество: `true` или `false`. `false` — не заказывать подсчёт. Это единственный способ гарантированно убрать `meta.total` из ответа. Без параметра — настройка ключа, затем платформенное умолчание, и тогда на короткой странице точное количество приходит и без заказа. [Листание и количество](/docs/entity-api#листание-и-количество-записей) |

## Примеры

### curl — личный ключ

```bash
curl "https://vibecode.bitrix24.tech/v1/leads?limit=10&filter[stageId]=NEW&select=id,title,stageId,amount" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth-приложение

```bash
curl "https://vibecode.bitrix24.tech/v1/leads?limit=10&filter[stageId]=NEW&select=id,title,stageId,amount" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads?limit=10&filter[stageId]=NEW&select=id,title,stageId,amount', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} лидов`)
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads?limit=10&filter[stageId]=NEW&select=id,title,stageId,amount', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `data` | array | Массив лидов (поля — см. [Поля](/docs/entities/leads/fields)) |
| `meta.total` | number | Общее количество записей. Необязательное поле: если количество не заказывалось, его в ответе нет |
| `meta.hasMore` | boolean | Есть ещё записи |
| `meta.nextAfterId` | string | Идентификатор последней отданной записи. Приходит при сортировке строго по `id` по возрастанию, пока `hasMore` равен `true`. Передайте его обратно как `filter[>id]` — это дешёвая замена растущему `offset` |

URL карточки любого лида из массива `data` — его `id`:

```
https://<portal>.bitrix24.ru/crm/lead/details/<id>/
```

`<portal>` — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

```json
{
  "success": true,
  "data": [
    {
      "id": 42,
      "title": "Заявка с сайта #42",
      "name": "Алексей",
      "lastName": "Иванов",
      "stageId": "NEW",
      "opportunity": 150000,
      "currencyId": "RUB",
      "assignedById": 1,
      "sourceId": "WEB",
      "createdTime": "2026-04-10T14:30:00+03:00"
    }
  ],
  "meta": {
    "total": 834,
    "hasMore": true
  }
}
```

## Пример ответа при ошибке

403 — нет скоупа:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Известные особенности

**Фильтр по телефону подходит не для всякого поиска.** Значение без оператора сравнивается со всей сохранённой строкой: лид с номером `+7 (999) 123-45-67` найдётся по этой же строке и не найдётся по `79991234567`, потому что плюс, пробелы, скобки и дефисы — часть значения. Вдобавок фильтр видит только первый номер записи: если записаны рабочий и мобильный, по мобильному он вернёт пустой список. Чтобы найти лид по номеру телефона в любом написании и по любому из его номеров, используйте [Поиск дубликатов](/docs/duplicates).

**Авто-пагинация:** при `limit > 50` Вайбкод автоматически запрашивает несколько страниц.

**Когда использовать search:** для сложных фильтров — `POST /v1/leads/search`, параметры передаются в body. См. [Поиск лидов](/docs/entities/leads/search).

## Смотрите также

- [Поиск лидов](/docs/entities/leads/search)
- [Поля лида](/docs/entities/leads/fields)
- [Поиск дубликатов](/docs/duplicates)
- [Синтаксис фильтрации](/docs/filtering)
- [Batch](/docs/batch)
- [Лимиты и оптимизация](/docs/optimization)