Get Site Folders landing.site.getFolders

Scope: landing

Who can execute the method: any user with "view" access permission for the site

The method landing.site.getFolders returns a list of site folders.

Method Parameters

Required parameters are marked with *

Name
type

Description

siteId*
integer

The identifier of the site for which folders are requested.

The site identifier can be obtained using the method landing.site.getList or from the result of the method landing.site.add

filter
object

Filter by folder fields (detailed description)

Filter Parameter

Name `type`	Description
ID `integer`	The identifier of the folder
PARENT_ID `integer` \| `null`	The identifier of the parent folder. If `0`, `null`, `false`, or an empty string is passed, the value will be converted to `null`, which retrieves top-level folders
INDEX_ID `integer`	The identifier of the folder's index page
ACTIVE `string`	Active flag `Y/N`
DELETED `string`	Deleted flag `Y/N`
=DELETED `string`	Exact match for the deleted flag. If `DELETED` and `=DELETED` are not present in the request, the method automatically adds `=DELETED: "N"`
TITLE `string`	The title of the folder
CODE `string`	The symbolic code of the folder
CREATED_BY_ID `integer`	The identifier of the user who created the folder
MODIFIED_BY_ID `integer`	The identifier of the user who modified the folder
DATE_CREATE `datetime`	The date and time the folder was created
DATE_MODIFY `datetime`	The date and time the folder was modified

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 1817,
            "filter": {
              "PARENT_ID": 0,
              "=DELETED": "N",
              "ACTIVE": "Y"
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.getFolders.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 1817,
            "filter": {
              "PARENT_ID": 0,
              "=DELETED": "N",
              "ACTIVE": "Y"
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.site.getFolders.json"

try
        {
        	const response = await $b24.callMethod(
        		'landing.site.getFolders',
        		{
        			siteId: 1817,
        			filter: {
        				PARENT_ID: 0,
        				'=DELETED': 'N',
        				ACTIVE: 'Y'
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.site.getFolders',
                    [
                        'siteId' => 1817,
                        'filter' => [
                            'PARENT_ID' => 0,
                            '=DELETED' => 'N',
                            'ACTIVE' => 'Y',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting folders: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.site.getFolders',
            {
                siteId: 1817,
                filter: {
                    PARENT_ID: 0,
                    '=DELETED': 'N',
                    ACTIVE: 'Y'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.site.getFolders',
            [
                'siteId' => 1817,
                'filter' => [
                    'PARENT_ID' => 0,
                    '=DELETED' => 'N',
                    'ACTIVE' => 'Y',
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Response Handling

HTTP Status: 200

{
            "result": [
                {
                    "ID": "1",
                    "PARENT_ID": null,
                    "SITE_ID": "3",
                    "INDEX_ID": "9",
                    "ACTIVE": "Y",
                    "DELETED": "N",
                    "TITLE": "test page transfer",
                    "CODE": "change",
                    "CREATED_BY_ID": "1",
                    "MODIFIED_BY_ID": "29",
                    "DATE_CREATE": "11/12/2021 08:39:53 pm",
                    "DATE_MODIFY": "12/28/2021 03:04:04 pm"
                },
                {
                    "ID": "33",
                    "PARENT_ID": null,
                    "SITE_ID": "3",
                    "INDEX_ID": null,
                    "ACTIVE": "Y",
                    "DELETED": "N",
                    "TITLE": "mobile",
                    "CODE": "mobile",
                    "CREATED_BY_ID": "29",
                    "MODIFIED_BY_ID": "29",
                    "DATE_CREATE": "12/08/2021 10:23:37 am",
                    "DATE_MODIFY": "12/08/2021 10:24:48 am"
                },
                {
                    "ID": "3",
                    "PARENT_ID": null,
                    "SITE_ID": "3",
                    "INDEX_ID": "45",
                    "ACTIVE": "Y",
                    "DELETED": "N",
                    "TITLE": "attachment 1",
                    "CODE": "attachment1",
                    "CREATED_BY_ID": "1",
                    "MODIFIED_BY_ID": "29",
                    "DATE_CREATE": "11/12/2021 08:39:53 pm",
                    "DATE_MODIFY": "12/03/2021 08:10:21 am"
                }
            ],
            "time": {
                "start": 1773257990,
                "finish": 1773257990.091689,
                "duration": 0.0916891098022461,
                "processing": 0,
                "date_start": "2026-03-11T22:39:50+01:00",
                "date_finish": "2026-03-11T22:39:50+01:00",
                "operating_reset_at": 1773258590,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object[]`	A list of site folders (detailed description). The method may return `result: []` without an error if there are no folders on the site or if the user does not have "view" access permission for the specified site
time `time`	Information about the execution time of the request

Folder Object

Name `type`	Description
ID `string`	The identifier of the folder
PARENT_ID `string` \| `null`	The identifier of the parent folder
SITE_ID `string`	The identifier of the site
INDEX_ID `string` \| `null`	The identifier of the folder's index page
ACTIVE `string`	Active flag `Y/N`
DELETED `string`	Deleted flag `Y/N`
TITLE `string`	The title of the folder
CODE `string`	The symbolic code of the folder
CREATED_BY_ID `string`	The identifier of the user who created the folder
MODIFIED_BY_ID `string`	The identifier of the user who modified the folder
DATE_CREATE `string`	The date and time of creation in string format
DATE_MODIFY `string`	The date and time of modification in string format

Error Handling

HTTP Status: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Insufficient call parameters, missing: siteId"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description
`MISSING_PARAMS`	The required parameter `siteId` was not provided
`ACCESS_DENIED`	Insufficient general rights to call landing methods
`TYPE_ERROR`	Data type error in method call parameters
`SYSTEM_ERROR`	Internal error during method execution

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Export Site

Get List of Sites

Get Site Folders landing.site.getFolders

Method ParametersMethod Parameters

Filter ParameterFilter Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Folder ObjectFolder Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning