Site folders

Folders group site pages and set the path segment of their URL. This section also covers publishing a folder, unpublishing it, moving it to the trash and restoring it.

Scope: landing | Base URL: https://vibecode.bitrix24.com/v1 | Authorization: X-Api-Key

List site folders

GET /v1/sites/:id/folders

Returns the site's folders.

Parameters

Parameter	Type	Required	Description
Parameter`id` (path)	Typenumber	Requiredyes	DescriptionSite ID — a positive integer. List: `GET /v1/sites`
Parameter`scope` (query)	Typestring	Requiredno	DescriptionInternal landing scope: `KNOWLEDGE` / `GROUP` / `MAINPAGE`. Specify it if the site belongs to the corresponding scope. Otherwise `404 ENTITY_NOT_FOUND` is returned
Parameter`parentId` (query)	Typenumber	Requiredno	DescriptionParent folder ID — `data[].id` from this same list. Only folders nested directly in it are returned. An empty value `?parentId=` returns only folders in the site root. Without the parameter, folders of all levels are returned
Parameter`deleted` (query)	Typeboolean	Requiredno	Description`true` — only folders in the trash, `false` — only folders outside the trash. Without the parameter, folders in the trash are not returned

The parentId and deleted parameters can be passed together: the response contains folders that match both conditions. The method has no limit or offset parameters. Other query parameters, such as select, are ignored, and the response contains all folder fields.

Examples

curl — personal key

Terminal

curl "https://vibecode.bitrix24.com/v1/sites/233/folders" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal

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

const { success, data } = await res.json()
console.log(`Folders: ${data.length}`)

JavaScript — OAuth application

javascript

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

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

Response fields

Field	Type	Description
Field`success`	Typeboolean	Description`true` on success
Field`data`	Typearray	DescriptionArray of folders. Empty if no folder matches the conditions
Field`data[].id`	Typenumber	DescriptionFolder ID
Field`data[].parentId`	Typenumber \| null	DescriptionParent folder ID. `null` — the folder is in the site root
Field`data[].siteId`	Typenumber	DescriptionSite ID. List: `GET /v1/sites`
Field`data[].indexPageId`	Typenumber \| null	DescriptionID of the folder's index page — a page from `GET /v1/pages`. `null` if not assigned
Field`data[].active`	Typeboolean	DescriptionWhether the folder is published
Field`data[].deleted`	Typeboolean	DescriptionWhether the folder is in the trash
Field`data[].title`	Typestring	DescriptionFolder name
Field`data[].code`	Typestring	DescriptionFolder symbolic code — the URL segment of its pages
Field`data[].createdById`	Typenumber \| null	DescriptionID of the user who created the folder. List: `GET /v1/users`
Field`data[].modifiedById`	Typenumber \| null	DescriptionID of the user who last modified the folder. List: `GET /v1/users`
Field`data[].dateCreate`	Typestring \| null	DescriptionCreation date in ISO 8601 format without a time zone, in Bitrix24 account time, for example `2026-10-16T15:49:43`
Field`data[].dateModify`	Typestring \| null	DescriptionLast modification date in the same format

Response example

JSON

{
  "success": true,
  "data": [
    {
      "id": 121,
      "parentId": null,
      "siteId": 233,
      "indexPageId": null,
      "active": false,
      "deleted": false,
      "title": "Docs test archive",
      "code": "archive",
      "createdById": 1317,
      "modifiedById": 1317,
      "dateCreate": "2026-10-16T15:49:55",
      "dateModify": "2026-10-16T15:49:55"
    },
    {
      "id": 119,
      "parentId": 117,
      "siteId": 233,
      "indexPageId": null,
      "active": false,
      "deleted": false,
      "title": "Docs test sneakers",
      "code": "sneakers",
      "createdById": 1317,
      "modifiedById": 1317,
      "dateCreate": "2026-10-16T15:49:53",
      "dateModify": "2026-10-16T15:49:53"
    },
    {
      "id": 117,
      "parentId": null,
      "siteId": 233,
      "indexPageId": null,
      "active": false,
      "deleted": false,
      "title": "Docs test catalog",
      "code": "catalog",
      "createdById": 1317,
      "modifiedById": 1317,
      "dateCreate": "2026-10-16T15:49:43",
      "dateModify": "2026-10-16T15:49:43"
    }
  ]
}

Error response example

404 — site not found: