## Список контактов лида

`GET /v1/leads/:id/contacts`

Возвращает связи лида с контактами: ID контакта, порядок и признак основного, чтобы перед правкой состава знать, кто привязан.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|----------|
| `id` (path) | number | да | ID лида. Список: [`GET /v1/leads`](/docs/entities/leads/list) |

Пагинации нет: ответ содержит все связи лида за один вызов.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/leads/1001321/contacts" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/leads/1001321/contacts" \
  -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/1001321/contacts', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
const primary = data.find((link) => link.isPrimary)
console.log('Основной контакт:', primary?.contactId)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/1001321/contacts', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

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

| Поле | Тип | Описание |
|------|-----|----------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Связи лида с контактами в порядке `sort`. У лида без контактов и у несуществующего лида — пустой массив |
| `data[].contactId` | number | ID контакта. Получить контакт: [`GET /v1/contacts/:id`](/docs/entities/contacts/get) |
| `data[].isPrimary` | boolean | Основной контакт лида. У лида с контактами `true` ровно у одной связи |
| `data[].sort` | number | Порядок контакта в списке |
| `data[].roleId` | number | Роль контакта в лиде. Методы связей её не сохраняют |

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

```json
{
  "success": true,
  "data": [
    { "contactId": 2937, "sort": 10, "isPrimary": false, "roleId": 0 },
    { "contactId": 2939, "sort": 20, "isPrimary": true, "roleId": 0 },
    { "contactId": 2941, "sort": 30, "isPrimary": false, "roleId": 0 }
  ]
}
```

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

400 — `id` не является положительным целым числом:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "id must be a positive integer"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | `id` не является положительным целым числом, например `abc` или `0` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `TOKEN_MISSING` | К ключу не привязаны токены Битрикс24 |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `crm` |
| 429 | `RATE_LIMITED` | Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке `x-ratelimit-limit`. Повторите после срока из заголовка `Retry-After` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен. Повторите запрос позже |

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

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

- **Пустой список не доказывает, что лид есть.** Для удалённого лида и для ID, которого не было, ответ тот же, что у лида без контактов. Существование лида проверяйте через [`GET /v1/leads/:id`](/docs/entities/leads/get): для несуществующего лида он отвечает `404`.
- **ID из списка может не вести к контакту.** Привязка не проверяет ID контакта, поэтому в списке бывает ID, которого нет среди контактов. Перед работой с контактом запросите его через [`GET /v1/contacts/:id`](/docs/entities/contacts/get).
- **Контакты вместе с лидом.** [`GET /v1/leads/:id?include=contactBinding`](/docs/entities/leads/get) возвращает лид и полные записи привязанных контактов в `data._included.contactBindings`. С `include=contact` в `data._included.contact` приходит один объект — основной контакт. ID основного контакта приходит в поле лида `contactId`, ID всех привязанных — в `contactIds`.

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

- [Контакты лида](/docs/entities/leads/contacts)
- [Привязать контакт к лиду](/docs/entities/leads/contacts-create)
- [Заменить контакты лида](/docs/entities/leads/contacts-set)
- [Отвязать контакт от лида](/docs/entities/leads/contacts-delete-delete)
- [Отвязать все контакты от лида](/docs/entities/leads/contacts-delete)
- [Получить лид](/docs/entities/leads/get)
- [Контакты](/docs/entities/contacts)
