## Get a form contract field

`GET /v1/crm-forms/fields/:name`

Returns the description of a single top-level CRM form property by name. Call it to check the type and multiplicity of a specific property without loading the whole list.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `name` (path) | string | yes | Form property name, for example `name`, `fields`, `appearance`, `analytics`, `integrations` or `spamProtection`. List: `data[].name` in [Form contract fields](/docs/entities/crm-forms/fields) |
| `select` (query) | string | no | Comma-separated metadata properties, for example `name,type,multiple` |

## Examples

### curl — personal key

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

### curl — OAuth application

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

const { success, data } = await res.json()
console.log('Property type:', data.type)
```

### JavaScript — OAuth application

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

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

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | object | Form property description. The object has the same fields as a `data[]` element in [Form contract fields](/docs/entities/crm-forms/fields) |

## Response example

```json
{
  "success": true,
  "data": {
    "name": "analytics",
    "type": "object",
    "elementType": null,
    "multiple": false,
    "title": "analytics",
    "description": null,
    "validationRules": [],
    "requiredGroups": null,
    "filterable": false,
    "sortable": false,
    "editable": false
  }
}
```

## Error response example

404 — no property with this name:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Field `unknownProperty` not found",
    "b24Code": "BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|----------|
| 404 | `ENTITY_NOT_FOUND` | No property with this `name`. The original code is in `error.b24Code` |
| 400 | `INVALID_PARAMS` | An unknown query parameter was passed |
| 400 | `INVALID_PARAMS` | `select` is not a string or an array of strings |
| 400 | `INVALID_PARAMS` | Bitrix24 rejected the projection. The original code is in `error.b24Code` |
| 403 | `BITRIX_ACCESS_DENIED` | The Bitrix24 user lacks permission to access forms |
| 403 | `BITRIX_INSUFFICIENT_SCOPE` | The Bitrix24 token lacks the required scope |
| 409 | `CRM_FORM_REST_NOT_ENABLED` | The CRM form REST methods are unavailable on this Bitrix24 account. This does not mean that an individual form is missing |
| 400–599 | `CRM_FORM_*` | Rejection under form rules. The code and HTTP status are preserved. The original code is in `error.b24Code` |
| 422 | `BITRIX_ERROR` | Another Bitrix24 rejection. The reason is in `error.message`. The original code is in `error.b24Code` |
| 429 | `RATE_LIMITED` | Request rate exceeded. Follow the `Retry-After` header |
| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 returned an unexpected response shape |
| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable: a server error or a dropped connection |
| 503 | `BITRIX_TIMEOUT` | Bitrix24 did not respond in time. The read can be retried |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 401 | `TOKEN_MISSING` | The key has no configured Bitrix24 credentials |
| 403 | `SCOPE_DENIED` | The Vibecode API key lacks the `crm` scope |

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

## See also

- [Form contract fields](/docs/entities/crm-forms/fields)
- [Get a form](/docs/entities/crm-forms/get)
- [Create a form](/docs/entities/crm-forms/create)
- [CRM forms](/docs/entities/crm-forms)