Get the List of Sites landing.site.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: user with "view" access permission for sites
The method landing.site.getList retrieves a list of sites based on the selection parameters.
Warning
By default, only sites with DELETED = "N" are included in the selection. To retrieve deleted sites, pass DELETED or =DELETED in the filter.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
scope |
Internal scope of landings. It is not related to the REST scope For |
|
params |
Parameters for selecting sites (detailed description) |
Parameter params
|
Name |
Description |
|
select |
List of fields to select from basic site fields. If the parameter is not passed or is not an array, |
|
filter |
Filter by fields from basic site fields. If the parameter is not passed or is not an array, an empty filter If the parameter Exact filtering by type works only for one value that is allowed in the current internal |
|
order |
Sorting in the format |
|
group |
Grouping in ORM format. If not an array, the parameter is converted to an empty array. When filtering by access rights, |
|
limit |
Limit on the number of rows in the selection at the ORM level. By default, it is not set. |
|
offset |
Offset for the selection at the ORM level. If the parameter is not passed, the default ORM behavior is applied. |
TYPE and scope Mapping
The types of sites and the rules for selecting the scope parameter are described in the article Working with Site Types and Scopes.
The table below applies to params.filter.TYPE and params.filter.=TYPE.
|
params.filter.TYPE |
scope in request |
When to use |
|
|
do not pass |
Selection of sites and stores in the standard |
|
|
|
Selection of group sites |
|
|
|
Selection of knowledge bases |
|
|
|
Selection of the main page or vibe |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"params": {
"select": [
"ID",
"TITLE",
"TYPE"
],
"filter": {
"=DELETED": "N"
},
"order": {
"ID": "DESC"
}
}
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.getList.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"params": {
"select": [
"ID",
"TITLE",
"TYPE"
],
"filter": {
"=DELETED": "N"
},
"order": {
"ID": "DESC"
}
},
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.site.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 site item returned in result[]
type SiteItem = {
ID: string
TITLE: string
TYPE: string
}
try {
// landing.site.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<SiteItem[]>({
method: 'landing.site.getList',
params: {
params: {
select: [
'ID',
'TITLE',
'TYPE',
],
filter: {
'=DELETED': 'N',
},
order: {
ID: 'DESC',
},
},
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('Sites fetched:', result.length, result)
}
} 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 getSiteList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// landing.site.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.site.getList',
params: {
params: {
select: [
'ID',
'TITLE',
'TYPE',
],
filter: {
'=DELETED': 'N',
},
order: {
ID: 'DESC',
},
},
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('Sites fetched:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getSiteList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.site.get_list(
params={
"select": [
"ID",
"TITLE",
"TYPE",
],
"filter": {
"=DELETED": "N",
},
"order": {
"ID": "DESC",
},
},
).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.site.getList',
[
'params' => [
'select' => [
'ID',
'TITLE',
'TYPE',
],
'filter' => [
'=DELETED' => 'N',
],
'order' => [
'ID' => 'DESC',
],
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting site list: ' . $e->getMessage();
}
BX24.callMethod(
'landing.site.getList',
{
params: {
select: [
'ID',
'TITLE',
'TYPE'
],
filter: {
'=DELETED': 'N'
},
order: {
ID: 'DESC'
}
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.site.getList',
[
'params' => [
'select' => [
'ID',
'TITLE',
'TYPE',
],
'filter' => [
'=DELETED' => 'N',
],
'order' => [
'ID' => 'DESC',
],
]
]
);
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.site.getList", b24.Params{
"params": b24.Params{
"select": []string{"ID", "TITLE", "TYPE"},
"filter": b24.Params{
"=DELETED": "N",
},
"order": b24.Params{
"ID": "DESC",
},
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("landing.site.getList: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
Title string `json:"TITLE"`
Type string `json:"TYPE"`
}
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": "157",
"TITLE": "Randu Villa",
"TYPE": "PAGE"
},
{
"ID": "147",
"TITLE": "Test Test yesss",
"TYPE": "STORE"
},
{
"ID": "3",
"TITLE": "Fork Museum",
"TYPE": "PAGE"
}
],
"time": {
"start": 1773269838,
"finish": 1773269838.647153,
"duration": 0.6471529006958008,
"processing": 0,
"date_start": "2026-03-12T01:57:18+01:00",
"date_finish": "2026-03-12T01:57:18+01:00",
"operating_reset_at": 1773270438,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
List of sites (detailed description). The method may return |
|
time |
Information about the execution time of the request. |
Site Object
|
Name |
Description |
|
ID |
Identifier of the site. This field is always present in the response. |
|
TYPE |
Type of the site. This field is always present in the response. |
|
DOMAIN_NAME |
Domain of the site, returned when selecting the field |
|
PUBLIC_URL |
Public URL of the site, returned when selecting the field It may be an empty string if the URL could not be determined. |
|
PREVIEW_PICTURE |
URL of the preview of the main page of the site, returned when selecting the field |
|
PHONE |
Phone number of the company from CRM, returned when selecting the field |
|
DATE_CREATE |
Creation date in string format, returned when selecting the field |
|
DATE_MODIFY |
Modification date in string format, returned when selecting the field |
|
LANDING_ID_INDEX |
May be present if |
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 rights to call landing methods. |
|
|
Data type error in method call parameters. |
|
|
Internal error during method execution. |
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 |