For AI agents: markdown of this page — /docs-content-en/lists/fields/get.md documentation index — /llms.txt

Get field

GET /v1/lists/:iblockId/fields/:fieldId

Returns the description of a single list field by its identifier. Useful when you need the parameters of a specific field rather than the whole set.

Parameters

Parameter Type Required Default Description
ParameteriblockId (path) Typestring Requiredyes Default— DescriptionList identifier or symbolic code. Values come from the ID or CODE fields of List lists
ParameterfieldId (path) Typestring Requiredyes Default— DescriptionField identifier from FIELD_ID in List fields. For user fields — PROPERTY_<number>, for system fields — a symbolic code, for example NAME
ParameteriblockTypeId (query) Typestring Requiredno Defaultlists DescriptionInfoblock type. Values:
lists — regular lists
lists_socnet — workgroup lists
bitrix_processes — service workflows
structure — company structure type containing the built-in absence calendar infoblock absence
ParametersocnetGroupId (query) Typenumber Requiredno Default— DescriptionWorkgroup identifier for lists of type lists_socnet. A positive integer from the id field of List workgroups

Examples

curl — personal key

Terminal 
curl https://vibecode.bitrix24.com/v1/lists/153/fields/PROPERTY_1207 \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl https://vibecode.bitrix24.com/v1/lists/153/fields/PROPERTY_1207 \
  -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/lists/153/fields/PROPERTY_1207', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
const field = Object.values(data)[0]
console.log('Field:', field.NAME)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/lists/153/fields/PROPERTY_1207', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Response fields

The data field contains the description of a single field, keyed by its type. In the path data.<TYPE>, <TYPE> is replaced by the type code, for example N or S:HTML. The List fields method uses FIELD_ID as the key. The response has no meta field.

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionObject with a single key — the field type code. The value is the field description object
Fielddata.<TYPE>.FIELD_ID Typestring DescriptionField identifier from List fields. For user fields — PROPERTY_<number>, for system fields — a symbolic code, for example NAME
Fielddata.<TYPE>.NAME Typestring DescriptionDisplay name of the field
Fielddata.<TYPE>.TYPE Typestring DescriptionField type code. Code reference — Field types
Fielddata.<TYPE>.IS_REQUIRED Typestring DescriptionWhether the field is required: Y or N
Fielddata.<TYPE>.MULTIPLE Typestring DescriptionAllows multiple values: Y or N
Fielddata.<TYPE>.SORT Typenumber DescriptionSort order in the form
Fielddata.<TYPE>.DEFAULT_VALUE Typestring, object or null DescriptionDefault value. The format depends on TYPE: for example, N uses a string containing a number, while S:HTML uses an object with the keys TYPE and TEXT
Fielddata.<TYPE>.CODE Typestring or null DescriptionSymbolic code of the user field. null if not set. Absent for system fields
Fielddata.<TYPE>.ID Typestring DescriptionNumeric identifier of the user field as a string — the numeric part of FIELD_ID. Absent for system fields
Fielddata.<TYPE>.PROPERTY_TYPE Typestring or boolean DescriptionBase type of the user field: S, N, L, F, G or E. For system fields — false
Fielddata.<TYPE>.PROPERTY_USER_TYPE Typeobject or boolean DescriptionDescription of the extended property type. Contains its base type PROPERTY_TYPE, code USER_TYPE, name DESCRIPTION, and handlers, which vary by type. false if there is no extended type
Fielddata.<TYPE>.LINK_IBLOCK_ID Typestring or null DescriptionLinked list identifier from the ID field of List lists. null if there is no link. Absent for system fields
Fielddata.<TYPE>.ROW_COUNT Typestring DescriptionInput field height in rows. Absent for system fields
Fielddata.<TYPE>.COL_COUNT Typestring DescriptionInput field width in characters. Absent for system fields
Fielddata.<TYPE>.USER_TYPE_SETTINGS Typeobject or null DescriptionExtended property type settings. The fields depend on TYPE, for example height for S:HTML. null if there are no settings. Absent for system fields
Fielddata.<TYPE>.SETTINGS Typeobject or boolean DescriptionField display settings in forms. false if no settings are configured. A system field can also return an object
Fielddata.<TYPE>.SETTINGS.SHOW_ADD_FORM Typestring DescriptionShow the field when adding an element: Y or N
Fielddata.<TYPE>.SETTINGS.SHOW_EDIT_FORM Typestring DescriptionShow the field when editing an element: Y or N
Fielddata.<TYPE>.SETTINGS.ADD_READ_ONLY_FIELD Typestring DescriptionThe field is read-only when adding an element: Y or N
Fielddata.<TYPE>.SETTINGS.EDIT_READ_ONLY_FIELD Typestring DescriptionThe field is read-only when editing an element: Y or N
Fielddata.<TYPE>.SETTINGS.SHOW_FIELD_PREVIEW Typestring DescriptionShow the field when previewing an element: Y or N
Fielddata.<TYPE>.DISPLAY_VALUES_FORM Typeobject or array DescriptionChoices for types L, G, E and E:...: the key is the identifier of an option, section or element; the value is its name. Returns an empty array [] if there are no choices

To get the field description, use Object.values(data)[0].

Response example

JSON 
{
  "success": true,
  "data": {
    "N": {
      "FIELD_ID": "PROPERTY_1207",
      "SORT": 20,
      "NAME": "Priority",
      "IS_REQUIRED": "N",
      "MULTIPLE": "N",
      "DEFAULT_VALUE": "0",
      "TYPE": "N",
      "PROPERTY_TYPE": "N",
      "PROPERTY_USER_TYPE": false,
      "CODE": "PRIORITY",
      "ID": "1207",
      "LINK_IBLOCK_ID": null,
      "ROW_COUNT": "1",
      "COL_COUNT": "30",
      "USER_TYPE_SETTINGS": null,
      "SETTINGS": {
        "SHOW_ADD_FORM": "Y",
        "SHOW_EDIT_FORM": "Y",
        "ADD_READ_ONLY_FIELD": "N",
        "EDIT_READ_ONLY_FIELD": "N",
        "SHOW_FIELD_PREVIEW": "N"
      }
    }
  }
}

Error response example

404 — field not found:

JSON 
{
  "success": false,
  "error": {
    "code": "FIELD_NOT_FOUND",
    "message": "Field not found"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_IBLOCK_TYPE DescriptioniblockTypeId is not one of the allowed types
HTTP404 CodeFIELD_NOT_FOUND DescriptionNo field with the specified fieldId exists in the list
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionNo permission to view the list
HTTP404 CodeLIST_NOT_FOUND DescriptionNo list with the specified iblockId exists
HTTP409 CodeLISTS_MODULE_NOT_ENABLED DescriptionThe lists module is not enabled on the portal
HTTP403 CodeSCOPE_DENIED DescriptionThe key is missing the lists scope
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured tokens

Full list of common API errors — Errors.

See also