Get a List of Pages landing.landing.getList
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
landingWho can execute the method: a user with "view" access permission for the site
The method landing.landing.getList retrieves a list of pages based on the selection parameters.
Warning
By default, the method returns only pages on non-deleted sites with DELETED = "N". To retrieve deleted pages, pass DELETED or =DELETED in the filter. This only works for pages on non-deleted sites: the method does not return pages from deleted sites.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
scope |
Internal scope of the landings. It is not related to the REST scope For regular pages, this parameter is not needed. For |
|
params |
Parameters for selecting pages (detailed description) |
Parameter params
|
Name |
Description |
|
select |
List of fields to select from Page Object Fields. If the parameter is not passed or is equal to The method only accepts simple field names of the page. Elements with |
|
filter |
Filter by fields from Page Object Fields. If the parameter is not passed or is in an incorrect format, the selection is performed without custom conditions. Keys with If The site identifier can be obtained using the method landing.site.getList |
|
order |
Sorting in the format |
|
group |
Grouping in ORM format. The method does not have a default value. |
|
limit |
Limit on the number of rows in the selection at the ORM level. The method does not set its own default limit. |
|
offset |
Offset for the selection at the ORM level. |
|
If the value evaluates to |
|
|
If the value evaluates to |
|
|
If the value evaluates to |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"params": {
"select": [
"ID",
"TITLE",
"SITE_ID",
"DATE_MODIFY"
],
"filter": {
"SITE_ID": 205,
"=DELETED": "N"
},
"order": {
"ID": "DESC"
},
"get_urls": true,
"get_preview": true,
"check_area": true
}
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.landing.getList.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"params": {
"select": [
"ID",
"TITLE",
"SITE_ID",
"DATE_MODIFY"
],
"filter": {
"SITE_ID": 205,
"=DELETED": "N"
},
"order": {
"ID": "DESC"
},
"get_urls": true,
"get_preview": true,
"check_area": true
},
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.landing.getList.json"
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each LandingItem returned in result[]
type LandingItem = {
ID: string
TITLE: string
SITE_ID: string
DATE_MODIFY: string
DOMAIN_ID: string | null
PUBLIC_URL?: string | null
PREVIEW?: string | null
IS_AREA?: boolean
}
try {
// landing.landing.getList returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<LandingItem[]>({
method: 'landing.landing.getList',
params: {
params: {
select: [
'ID',
'TITLE',
'SITE_ID',
'DATE_MODIFY',
],
filter: {
SITE_ID: 205,
'=DELETED': 'N',
},
order: {
ID: 'DESC',
},
get_urls: true,
get_preview: true,
check_area: true,
},
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Pages count:', result.length, 'First page:', result[0])
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getLandingList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// landing.landing.getList returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'landing.landing.getList',
params: {
params: {
select: [
'ID',
'TITLE',
'SITE_ID',
'DATE_MODIFY',
],
filter: {
SITE_ID: 205,
'=DELETED': 'N',
},
order: {
ID: 'DESC',
},
get_urls: true,
get_preview: true,
check_area: true,
},
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Pages count:', result.length, 'First page:', result[0])
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getLandingList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.landing.get_list(
params={
"select": [
"ID",
"TITLE",
"SITE_ID",
"DATE_MODIFY",
],
"filter": {
"SITE_ID": 205,
"=DELETED": "N",
},
"order": {
"ID": "DESC",
},
"get_urls": True,
"get_preview": True,
"check_area": True,
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'landing.landing.getList',
[
'params' => [
'select' => [
'ID',
'TITLE',
'SITE_ID',
'DATE_MODIFY',
],
'filter' => [
'SITE_ID' => 205,
'=DELETED' => 'N',
],
'order' => [
'ID' => 'DESC',
],
'get_urls' => true,
'get_preview' => true,
'check_area' => true,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting landing list: ' . $e->getMessage();
}
BX24.callMethod(
'landing.landing.getList',
{
params: {
select: [
'ID',
'TITLE',
'SITE_ID',
'DATE_MODIFY'
],
filter: {
SITE_ID: 205,
'=DELETED': 'N'
},
order: {
ID: 'DESC'
},
get_urls: true,
get_preview: true,
check_area: true
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.landing.getList',
[
'params' => [
'select' => [
'ID',
'TITLE',
'SITE_ID',
'DATE_MODIFY',
],
'filter' => [
'SITE_ID' => 205,
'=DELETED' => 'N',
],
'order' => [
'ID' => 'DESC',
],
'get_urls' => true,
'get_preview' => true,
'check_area' => true,
],
]
);
echo '<pre>';
print_r($result);
echo '</pre>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "landing.landing.getList", b24.Params{
"params": b24.Params{
"select": []string{"ID", "TITLE", "SITE_ID", "DATE_MODIFY"},
"filter": b24.Params{
"SITE_ID": 205,
"=DELETED": "N",
},
"order": b24.Params{
"ID": "DESC",
},
"get_urls": true,
"get_preview": true,
"check_area": true,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("landing.landing.getList: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
Title string `json:"TITLE"`
SiteID b24.ID `json:"SITE_ID"`
DateModify string `json:"DATE_MODIFY"`
DomainID b24.ID `json:"DOMAIN_ID"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Title)
}
Response Handling
HTTP Status: 200
{
"result": [
{
"ID": "985",
"TITLE": "Detailed News",
"SITE_ID": "3",
"DATE_MODIFY": "10/10/2022 03:25:30 pm",
"DOMAIN_ID": "5"
},
{
"ID": "573",
"TITLE": "Page Video",
"SITE_ID": "3",
"DATE_MODIFY": "10/10/2022 03:25:30 pm",
"DOMAIN_ID": "5"
}
],
"time": {
"start": 1773712560,
"finish": 1773712560.955928,
"duration": 0.9559280872344971,
"processing": 0,
"date_start": "2026-03-17T04:56:00+01:00",
"date_finish": "2026-03-17T04:56:00+01:00",
"operating_reset_at": 1773713160,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
List of pages (detailed description). The method may return |
|
time |
Information about the execution time of the request. |
Object page
|
Name |
Description |
|
FIELD |
Any field of the page from Page Object Fields, if it is requested in |
|
DOMAIN_ID |
Identifier of the domain of the site to which the page is linked. Present in the response even if it is not specified in |
|
PUBLIC_URL |
Public address of the page. Returned only if the |
|
PREVIEW |
Link to the page preview. Returned only if the |
|
IS_AREA |
Indicates whether the page is used as an included area. Returned only if the |
Error Handling
HTTP Status: 400
{
"error": "ACCESS_DENIED",
"error_description": "Access denied"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient permissions to call the method. |
|
|
Data type error in the method call parameters. |
|
|
Internal error while executing the method. |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |