[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-entities\u002Fcrm-forms\u002Ffield":3,"docs-tabs-entities\u002Fcrm-forms\u002Ffield":6},{"content":4,"lastmod":5},"## Get a form contract field\n\n`GET \u002Fv1\u002Fcrm-forms\u002Ffields\u002F:name`\n\nReturns 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.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|---------|\n| `name` (path) | string | yes | Form property name, for example `name`, `fields`, `appearance`, `analytics`, `integrations` or `spamProtection`. List: `data[].name` in [Form contract fields](\u002Fdocs\u002Fentities\u002Fcrm-forms\u002Ffields) |\n| `select` (query) | string | no | Comma-separated metadata properties, for example `name,type,multiple` |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fcrm-forms\u002Ffields\u002Fanalytics\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fcrm-forms\u002Ffields\u002Fanalytics\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fcrm-forms\u002Ffields\u002Fanalytics', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\nconsole.log('Property type:', data.type)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fcrm-forms\u002Ffields\u002Fanalytics', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|---------|\n| `success` | boolean | Always `true` on success |\n| `data` | object | Form property description. The object has the same fields as a `data[]` element in [Form contract fields](\u002Fdocs\u002Fentities\u002Fcrm-forms\u002Ffields) |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"name\": \"analytics\",\n    \"type\": \"object\",\n    \"elementType\": null,\n    \"multiple\": false,\n    \"title\": \"analytics\",\n    \"description\": null,\n    \"validationRules\": [],\n    \"requiredGroups\": null,\n    \"filterable\": false,\n    \"sortable\": false,\n    \"editable\": false\n  }\n}\n```\n\n## Error response example\n\n404 — no property with this name:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Field `unknownProperty` not found\",\n    \"b24Code\": \"BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 404 | `ENTITY_NOT_FOUND` | No property with this `name`. The original code is in `error.b24Code` |\n| 400 | `INVALID_PARAMS` | An unknown query parameter was passed |\n| 400 | `INVALID_PARAMS` | `select` is not a string or an array of strings |\n| 400 | `INVALID_PARAMS` | Bitrix24 rejected the projection. The original code is in `error.b24Code` |\n| 403 | `BITRIX_ACCESS_DENIED` | The Bitrix24 user lacks permission to access forms |\n| 403 | `BITRIX_INSUFFICIENT_SCOPE` | The Bitrix24 token lacks the required scope |\n| 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 |\n| 400–599 | `CRM_FORM_*` | Rejection under form rules. The code and HTTP status are preserved. The original code is in `error.b24Code` |\n| 422 | `BITRIX_ERROR` | Another Bitrix24 rejection. The reason is in `error.message`. The original code is in `error.b24Code` |\n| 429 | `RATE_LIMITED` | Request rate exceeded. Follow the `Retry-After` header |\n| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 returned an unexpected response shape |\n| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable: a server error or a dropped connection |\n| 503 | `BITRIX_TIMEOUT` | Bitrix24 did not respond in time. The read can be retried |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |\n| 401 | `TOKEN_MISSING` | The key has no configured Bitrix24 credentials |\n| 403 | `SCOPE_DENIED` | The Vibecode API key lacks the `crm` scope |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [Form contract fields](\u002Fdocs\u002Fentities\u002Fcrm-forms\u002Ffields)\n- [Get a form](\u002Fdocs\u002Fentities\u002Fcrm-forms\u002Fget)\n- [Create a form](\u002Fdocs\u002Fentities\u002Fcrm-forms\u002Fcreate)\n- [CRM forms](\u002Fdocs\u002Fentities\u002Fcrm-forms)\n","2026-11-06",{},1794739354614]