## Список связей реквизитов

`GET /v1/requisite-links`

Возвращает список связей реквизитов с поддержкой фильтрации и авто-пагинации. Каждая связь соединяет реквизит и банковский реквизит с конкретным владельцем — сделкой, счётом, предложением или элементом смарт-процесса.

## Параметры

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `limit` | number | `50` | Количество записей, до 5000 |
| `offset` | number | `0` | Пропустить N записей. При `offset > 0` рекомендуется `limit ≤ 500` |
| `filter` | object | — | Фильтрация по полям. Допустимые ключи: `entityTypeId`, `entityId`, `requisiteId`, `bankDetailId`, `mcRequisiteId`, `mcBankDetailId`. Поддерживаются операторы сравнения (`$gt`/`$gte`/`$lt`/`$lte` и префиксы `>=`/`>`), множества (`$in`/`$nin`). Логические `$or`/`$and` не поддерживаются.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[entityTypeId]=2&filter[entityId]=3773` |
| `sort` | string | — | Поле сортировки — один из ключей фильтра. Направление задаётся в `order` |
| `order` | string \| object | `asc` | Направление для `sort` (`asc`/`desc`), либо форма `order[поле]=asc\|desc` |

Пагинация: при `limit > 50` все записи приходят в одном ответе. Максимум — 5000 записей за вызов.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/requisite-links?filter[entityTypeId]=2&filter[entityId]=3773" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/requisite-links?filter[entityTypeId]=2&filter[entityId]=3773" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/requisite-links?filter[entityTypeId]=2&filter[entityId]=3773',
  { 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/requisite-links?filter[entityTypeId]=2&filter[entityId]=3773',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  },
)

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив связей |
| `data[].entityTypeId` | number | Тип владельца. Значения — [Поля связи](/docs/entities/requisite-links/fields) |
| `data[].entityId` | number | ID владельца |
| `data[].requisiteId` | number | ID реквизита клиента, `0` — не привязан. Источник: [`GET /v1/requisites`](/docs/entities/requisites/list) |
| `data[].bankDetailId` | number | ID банковского реквизита клиента, `0` — не привязан. Источник: [`GET /v1/bank-details`](/docs/entities/bank-details/list) |
| `data[].mcRequisiteId` | number | ID реквизита вашей компании, `0` — не привязан |
| `data[].mcBankDetailId` | number | ID банковского реквизита вашей компании, `0` — не привязан |
| `meta.total` | number | Общее количество записей, соответствующих фильтру |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |

Поля `meta` лежат рядом с `data`, а не внутри него. Обходить страницы нужно по `meta.hasMore`: длина `data`, равная `limit`, последней страницы не исключает.

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

```json
{
  "success": true,
  "data": [
    {
      "entityTypeId": 2,
      "entityId": 3773,
      "requisiteId": 45,
      "bankDetailId": 0,
      "mcRequisiteId": 0,
      "mcBankDetailId": 0
    },
    {
      "entityTypeId": 2,
      "entityId": 3825,
      "requisiteId": 0,
      "bankDetailId": 0,
      "mcRequisiteId": 0,
      "mcBankDetailId": 0
    }
  ],
  "meta": {
    "total": 68,
    "hasMore": true
  }
}
```

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

400 — фильтр по `entityId` без `entityTypeId`:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_ENTITY_TYPE_ID",
    "message": "Filtering by entityId requires entityTypeId too — B24 scopes requisite-link access by owner type. Add entityTypeId (e.g. 4 company, 3 contact) to the filter."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `MISSING_ENTITY_TYPE_ID` | Фильтр по `entityId` без `entityTypeId` |
| 400 | `UNKNOWN_FILTER_FIELD` | Неизвестное поле фильтра, в сообщении — список допустимых |
| 400 | `UNKNOWN_SORT_FIELD` | Неизвестное поле сортировки, в сообщении — список допустимых |
| 400 | `INVALID_FILTER_OPERATOR` | Логический оператор верхнего уровня `$or` или `$and` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

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

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

**У связи нет отдельного числового `id`.** Каждая связь определяется парой значений владельца — `entityTypeId` и `entityId`, именно они используются для получения и удаления записи.

**Связь в списке не означает наличия привязки.** Строка со всеми четырьмя идентификаторами, равными `0`, — это заведённая связь без единой привязки. Чтобы отобрать только реальные привязки, добавьте условие вида `?filter[>requisiteId]=0`.

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

- [Получить связь](/docs/entities/requisite-links/get)
- [Поиск связей](/docs/entities/requisite-links/search)
- [Зарегистрировать связь](/docs/entities/requisite-links/register)
- [Поля связи](/docs/entities/requisite-links/fields)
- [Реквизиты](/docs/entities/requisites/list)
- [Банковские реквизиты](/docs/entities/bank-details/list)
- [Синтаксис фильтрации](/docs/filtering)