## List requisite links

`GET /v1/requisite-links`

Returns a list of requisite links with support for filtering and auto-pagination. Each link connects a requisite and a bank requisite with a specific deal or invoice.

## Parameters

| Parameter | Type | Default | Description |
|----------|-----|-----------|---------|
| `limit` | number | `50` | Number of records (up to 5000). When `limit > 50`, Vibecode automatically requests multiple pages from Bitrix24 |
| `offset` | number | `0` | Skip N records. When `offset > 0`, `limit ≤ 500` is recommended |
| `filter` | object | — | Filtering by fields. Allowed keys: `entityTypeId`, `entityId`, `requisiteId`, `bankDetailId`, `mcRequisiteId`, `mcBankDetailId`. Comparison operators (`$gt`/`$gte`/`$lt`/`$lte` and `>=`/`>` prefixes) and set operators (`$in`/`$nin`) are supported. Logical `$or`/`$and` are not supported.<br>[Filtering syntax](/docs/filtering). Example: `?filter[entityTypeId]=2&filter[entityId]=3773` |
| `sort` | string | — | Sort field — one of the filter keys. Direction is set in `order` |
| `order` | string \| object | `asc` | Direction for `sort` (`asc`/`desc`), or the `order[field]=asc\|desc` form |

Pagination: when `limit > 50`, Vibecode automatically requests multiple pages from Bitrix24 and returns all records in a single response. Maximum — 5000 records per call.

## Examples

### curl — personal key

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

### curl — OAuth app

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

### JavaScript — personal key

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.com/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(`Found ${meta.total} links`)
```

### JavaScript — OAuth app

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.com/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()
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | Array of links |
| `data[].ENTITY_TYPE_ID` | string | Owner type: `"2"` — deal, `"31"` — invoice |
| `data[].ENTITY_ID` | string | Owner ID (deal or invoice). Source: `GET /v1/deals` or `GET /v1/invoices` |
| `data[].REQUISITE_ID` | string | Linked requisite ID; `"0"` — requisite not linked. Source: `GET /v1/requisites` |
| `data[].BANK_DETAIL_ID` | string | Linked bank requisite ID; `"0"` — not linked. Source: `GET /v1/bank-details` |
| `data[].MC_REQUISITE_ID` | string | Your company's requisite ID; `"0"` — not linked |
| `data[].MC_BANK_DETAIL_ID` | string | Your company's bank requisite ID; `"0"` — not linked |
| `meta.total` | number | Total number of records matching the filter |
| `meta.hasMore` | boolean | Whether more records exist beyond `limit` |

## Response example

```json
{
  "success": true,
  "data": [
    {
      "ENTITY_TYPE_ID": "2",
      "ENTITY_ID": "3773",
      "REQUISITE_ID": "45",
      "BANK_DETAIL_ID": "0",
      "MC_REQUISITE_ID": "0",
      "MC_BANK_DETAIL_ID": "0"
    },
    {
      "ENTITY_TYPE_ID": "2",
      "ENTITY_ID": "3825",
      "REQUISITE_ID": "0",
      "BANK_DETAIL_ID": "0",
      "MC_REQUISITE_ID": "0",
      "MC_BANK_DETAIL_ID": "0"
    },
    {
      "ENTITY_TYPE_ID": "2",
      "ENTITY_ID": "3827",
      "REQUISITE_ID": "0",
      "BANK_DETAIL_ID": "0",
      "MC_REQUISITE_ID": "0",
      "MC_BANK_DETAIL_ID": "0"
    }
  ],
  "meta": {
    "total": 410,
    "hasMore": true
  }
}
```

## Error response example

403 — no scope:

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

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API key lacks the `crm` scope |
| 401 | `TOKEN_MISSING` | `X-Api-Key` not provided |
| 400 | `INVALID_FILTER` | Error in filter syntax |
| 400 | `UNKNOWN_FILTER_FIELD` | Unknown filter field (the response lists the allowed ones) |
| 400 | `UNKNOWN_SORT_FIELD` | Unknown sort field |
| 400 | `INVALID_FILTER_OPERATOR` | Top-level logical operator (`$or`/`$and`) is not supported |
| 400 | `MISSING_ENTITY_TYPE_ID` | Filtering by `entityId` without `entityTypeId` |

Full list of common API errors — [Errors](/docs/errors).

## Known specifics

**Response fields use the original Bitrix24 names.** All fields are returned in upper case — `ENTITY_TYPE_ID`, `ENTITY_ID`, `REQUISITE_ID`, etc.; numeric identifier values arrive as strings, e.g. `"REQUISITE_ID": "45"`, `"BANK_DETAIL_ID": "0"`.

**A link has no separate numeric `id`.** Each link is identified by the owner value pair — `entityTypeId` and `entityId`; these are exactly what is used to get and delete a record.

**A value of `"0"` means no link.** For `REQUISITE_ID`, `BANK_DETAIL_ID`, `MC_REQUISITE_ID`, `MC_BANK_DETAIL_ID` the string `"0"` means the corresponding requisite is not linked, not that an object with ID 0 is linked.

## See also

- [Get a link](/docs/entities/requisite-links/get)
- [Search links](/docs/entities/requisite-links/search)
- [Register a link](/docs/entities/requisite-links/register)
- [Requisites](/docs/entities/requisites/list)
- [Bank details](/docs/entities/bank-details/list)
- [Filtering syntax](/docs/filtering)