For AI agents: markdown of this page — /docs-content-en/entities/sites/ai/field.md documentation index — /llms.txt

Get a generation field

GET /v1/sites/ai/fields/:name

Reads a field definition by its name.

Parameters

Parameter Type Required Default Description
Parametername (path) Typestring Requiredyes Default— DescriptionField name from field definitions

Examples

curl — personal key

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/sites/ai/fields/id" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/sites/ai/fields/id" \
  -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/sites/ai/fields/id", {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_API_KEY"
  }
});
const result = await res.json();
console.log(result);

JavaScript — OAuth application

javascript 
const res = await fetch("https://vibecode.bitrix24.com/v1/sites/ai/fields/id", {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN"
  }
});
const result = await res.json();
console.log(result);

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata Typeobject DescriptionField definition
Fielddata.name Typestring DescriptionField name
Fielddata.type Typestring DescriptionValue type
Fielddata.title Typestring DescriptionField title
Fielddata.description Typestring | null DescriptionField description or null
Fielddata.validationRules Typearray DescriptionValidation rules
Fielddata.requiredGroups Typearray | null DescriptionRequired groups or null
Fielddata.filterable Typeboolean DescriptionCan be filtered
Fielddata.sortable Typeboolean DescriptionCan be sorted
Fielddata.editable Typeboolean DescriptionCan be edited
Fielddata.editableGroups Typearray | null DescriptionEditing groups or null
Fielddata.multiple Typeboolean DescriptionMultiple values
Fielddata.elementType Typestring | null DescriptionElement type or null

Response example

JSON 
{
  "success": true,
  "data": {
    "name": "id",
    "type": "int",
    "title": "Site generation identifier",
    "description": null,
    "validationRules": [],
    "requiredGroups": null,
    "filterable": false,
    "sortable": false,
    "editable": false,
    "editableGroups": null,
    "multiple": false,
    "elementType": null
  }
}

Error response example

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Field `FAKE_UNKNOWN_FIELD` was not found"
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionBitrix24 refused the request
HTTP401 CodeMISSING_API_KEY, INVALID_API_KEY, TOKEN_MISSING DescriptionMissing or unusable credentials
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the landing scope

Common errors.

See also