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

Section fields

GET /v1/catalog-sections/fields

Returns a reference of catalog section fields with their types, read-only and nullable flags, along with the list of operations available in a batch request.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/catalog-sections/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/catalog-sections/fields" \
  -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/catalog-sections/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Fields:', Object.keys(data.fields).length)

JavaScript — OAuth application

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

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

Response fields

data.fields is an object whose key matches the field name, and whose value contains type (the field type), readonly (true — the field cannot be passed on create or update) and nullable (present when the field can come back as null). data.batch is the list of operations accepted by a batch request.

Field Type RO Description
id number yes Section identifier
iblockId number no ID of the catalog the section belongs to. List: GET /v1/catalogs
iblockSectionId number | null no ID of the parent section. null for a top-level section
name string no Section name
xmlId string | null no External identifier. null when not set
code string | null no Symbolic code of the section. null when not set
sort number no Sort index
active boolean no Whether the section is active
description string | null no Section description. null when not set
descriptionType string no Description format: text or html
Field Type Description
success boolean Always true on success
data.fields.<name>.type string Field type: number, string, boolean, datetime
data.fields.<name>.readonly boolean true — the field is set by the system and is not accepted on create and update
data.fields.<name>.nullable boolean true — the field can come back as null. The key is present only on such fields
data.batch string[] Section operations available in a batch request: create, update, delete

Response example

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "iblockId": { "type": "number", "readonly": false },
      "iblockSectionId": { "type": "number", "readonly": false, "nullable": true },
      "name": { "type": "string", "readonly": false },
      "xmlId": { "type": "string", "readonly": false, "nullable": true },
      "code": { "type": "string", "readonly": false, "nullable": true },
      "sort": { "type": "number", "readonly": false },
      "active": { "type": "boolean", "readonly": false },
      "description": { "type": "string", "readonly": false, "nullable": true },
      "descriptionType": { "type": "string", "readonly": false }
    },
    "batch": ["create", "update", "delete"]
  }
}

Error response example

403 — no scope:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'catalog' scope"
  }
}

Errors

HTTP Code Description
403 SCOPE_DENIED The API key does not have the catalog scope
401 MISSING_API_KEY The X-Api-Key header was not provided

The full list of common API errors — Errors.

See also