#Catalog sections
Entity: catalogSection | Scope: catalog | Base path: /v1/catalog-sections
SPA entity (camelCase field names) — field names pass through without transformation.
#Operations
| Method | Path | Description | Bitrix24 Method |
|---|---|---|---|
GET |
/v1/catalog-sections |
List all (with filter, sort, pagination) | catalog.section.list |
GET |
/v1/catalog-sections/:id |
Get by ID | catalog.section.get |
POST |
/v1/catalog-sections |
Create new | catalog.section.add |
PATCH |
/v1/catalog-sections/:id |
Update by ID | catalog.section.update |
DELETE |
/v1/catalog-sections/:id |
Delete by ID | catalog.section.delete |
#Fields
| API Name | Bitrix24 Name | Type | Readonly | Description |
|---|---|---|---|---|
id |
id |
number | yes | Идентификатор записи |
iblockId |
iblockId |
number | ||
iblockSectionId |
iblockSectionId |
number | ||
name |
name |
string | ||
xmlId |
xmlId |
string | ||
code |
code |
string | ||
sort |
sort |
number | ||
active |
active |
boolean | ||
description |
description |
string | ||
dateCreate |
dateCreate |
datetime | yes | |
createdBy |
createdBy |
number | yes | ID создателя |
modifiedBy |
modifiedBy |
number | yes |
#Examples
#List
curl -X GET '/v1/catalog-sections?limit=10' \
-H 'X-Api-Key: YOUR_KEY'
#Get by ID
curl -X GET '/v1/catalog-sections/123' \
-H 'X-Api-Key: YOUR_KEY'
#Create
curl -X POST '/v1/catalog-sections' \
-H 'X-Api-Key: YOUR_KEY' \
-H 'Content-Type: application/json' \
-d '{"iblockId":1,"iblockSectionId":1,"name":"value"}'
#Update
curl -X PATCH '/v1/catalog-sections/123' \
-H 'X-Api-Key: YOUR_KEY' \
-H 'Content-Type: application/json' \
-d '{"title":"updated"}'
#Delete
curl -X DELETE '/v1/catalog-sections/123' \
-H 'X-Api-Key: YOUR_KEY'
#Batch
curl -X POST '/v1/batch' \
-H 'X-Api-Key: YOUR_KEY' \
-H 'Content-Type: application/json' \
-d '{"calls":[{"entity":"catalog-sections","action":"list","params":{"limit":5}}]}'