[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-entities\u002Fsites\u002Fai\u002Ffield":3,"docs-tabs-entities\u002Fsites\u002Fai\u002Ffield":6},{"content":4,"lastmod":5},"## Get a generation field\n\n`GET \u002Fv1\u002Fsites\u002Fai\u002Ffields\u002F:name`\n\nReads a field definition by its name.\n\n## Parameters\n\n| Parameter | Type | Required | Default | Description |\n|---|---|---|---|---|\n| `name` (path) | string | yes | — | Field name from [field definitions](.\u002Ffields.md) |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X GET \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fsites\u002Fai\u002Ffields\u002Fid\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X GET \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fsites\u002Fai\u002Ffields\u002Fid\" \\\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\u002Fsites\u002Fai\u002Ffields\u002Fid\", {\n  \"method\": \"GET\",\n  \"headers\": {\n    \"X-Api-Key\": \"YOUR_API_KEY\"\n  }\n});\nconst result = await res.json();\nconsole.log(result);\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch(\"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fsites\u002Fai\u002Ffields\u002Fid\", {\n  \"method\": \"GET\",\n  \"headers\": {\n    \"X-Api-Key\": \"YOUR_APP_KEY\",\n    \"Authorization\": \"Bearer USER_SESSION_TOKEN\"\n  }\n});\nconst result = await res.json();\nconsole.log(result);\n```\n\n## Response fields\n\n| Field | Type | Description |\n|---|---|---|\n| `success` | boolean | `true` on success |\n| `data` | object | Field definition |\n| `data.name` | string | Field name |\n| `data.type` | string | Value type |\n| `data.title` | string | Field title |\n| `data.description` | string \\| null | Field description or null |\n| `data.validationRules` | array | Validation rules |\n| `data.requiredGroups` | array \\| null | Required groups or null |\n| `data.filterable` | boolean | Can be filtered |\n| `data.sortable` | boolean | Can be sorted |\n| `data.editable` | boolean | Can be edited |\n| `data.editableGroups` | array \\| null | Editing groups or null |\n| `data.multiple` | boolean | Multiple values |\n| `data.elementType` | string \\| null | Element type or null |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"name\": \"id\",\n    \"type\": \"int\",\n    \"title\": \"Site generation identifier\",\n    \"description\": null,\n    \"validationRules\": [],\n    \"requiredGroups\": null,\n    \"filterable\": false,\n    \"sortable\": false,\n    \"editable\": false,\n    \"editableGroups\": null,\n    \"multiple\": false,\n    \"elementType\": null\n  }\n}\n```\n\n## Error response example\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Field `FAKE_UNKNOWN_FIELD` was not found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|---|---|---|\n| 404 | `ENTITY_NOT_FOUND` | Bitrix24 refused the request |\n| 401 | `MISSING_API_KEY`, `INVALID_API_KEY`, `TOKEN_MISSING` | Missing or unusable credentials |\n| 403 | `SCOPE_DENIED` | The key lacks the landing scope |\n\n[Common errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [AI site generation](..\u002Fai.md)\n","2026-11-13",{},1794739417644]