## Requisite link fields

`GET /v1/requisite-links/fields`

Returns the schema of requisite link fields — description, types, and flags for all six fields.

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/requisite-links/fields" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth app

```bash
curl "https://vibecode.bitrix24.com/v1/requisite-links/fields" \
  -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/fields', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success, data } = await res.json()
console.log('Fields:', Object.keys(data.fields))
```

### JavaScript — OAuth app

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-links/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

## Response fields

| Field | Type | RO | Description |
|------|-----|:--:|---------|
| `success` | boolean | | Always `true` on success |
| `data.fields` | object | | Field schema. Keys are names in `UPPER_SNAKE_CASE` |
| `data.fields.ENTITY_TYPE_ID` | object | | Link owner type: `2` — deal, `31` — invoice |
| `data.fields.ENTITY_ID` | object | | Owner entity ID |
| `data.fields.REQUISITE_ID` | object | | Client requisite ID; `"0"` — not linked |
| `data.fields.BANK_DETAIL_ID` | object | | Client bank requisite ID; `"0"` — not linked |
| `data.fields.MC_REQUISITE_ID` | object | | Your company's requisite ID; `"0"` — not linked |
| `data.fields.MC_BANK_DETAIL_ID` | object | | Your company's bank requisite ID; `"0"` — not linked |

Each field object contains: `type`, `isRequired`, `isReadOnly`, `isImmutable`, `isMultiple`, `isDynamic`, `title`.

## Response example

```json
{
  "success": true,
  "data": {
    "fields": {
      "ENTITY_TYPE_ID": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Entity type ID"
      },
      "ENTITY_ID": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Entity ID"
      },
      "REQUISITE_ID": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Requisite link"
      },
      "BANK_DETAIL_ID": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Bank requisite link"
      },
      "MC_REQUISITE_ID": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "My company requisite link"
      },
      "MC_BANK_DETAIL_ID": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "My company bank requisite link"
      }
    }
  }
}
```

## 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` | API key has no configured tokens |

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

## See also

- [Register a link](/docs/entities/requisite-links/register)
- [List links](/docs/entities/requisite-links/list)
- [Entity API](/docs/entity-api)