Page Fields

Field
type

Description

ID
integer

Identifier of the page. In landing.landing.getList, this field is always present in the response

TITLE
string

Title of the page. This field is required when creating via landing.landing.add

CODE
string

Symbolic code of the page. It forms the page address within the site. When creating, if the field is not passed or a string of spaces is passed, the code is generated from TITLE.

If the generated address matches the address of an already existing page in the same section of the site, the system will automatically add a suffix of 4 random characters to CODE, for example, my-page_a1b2. The final value of CODE may differ from the one passed

SITE_ID
integer

Identifier of the site to which the page belongs

FOLDER_ID
integer

Identifier of the folder in which the page is located. If the value is empty or equals 0, the page is in the root of the site

TPL_ID
integer

Identifier of the view template for the page. If the value is empty, the page uses the site template

ACTIVE
string

Publication status of the page.

Possible values:
Y the page is published
N the page is not published

A new page is created with the value N. To change the status, use landing.landing.publication and landing.landing.unpublic

DELETED
string

Trash flag.

Possible values:
Y the page is in the trash
N the page is not in the trash

When moved to the trash, the page automatically receives ACTIVE = "N". For deletion and restoration, use landing.landing.markDelete and landing.landing.markUnDelete

DESCRIPTION
string

Arbitrary description of the page. Displayed in the list of pages

XML_ID
string

External identifier of the page

SITEMAP
string

Flag for including the page in the sitemap.

Possible values:
Y the page is included in sitemap.xml
N the page is not included in sitemap.xml

FOLDER
string

Indicator that the object is used as a folder in the site structure, rather than as a regular page.

Possible values:
Y the object is a folder
N the object is a page

A folder is needed to group pages within the site. It can be created using the method landing.landing.add by passing FOLDER = Y

RULE
string

Regular expression for displaying the page by mask. For example, the rule section/([\d]+) for a page in the root of the site will match addresses like /section/<n>/, where <n> is any number

CREATED_BY_ID
integer

Identifier of the user who created the page

MODIFIED_BY_ID
integer

Identifier of the user who last modified the page

DATE_CREATE
datetime

Date and time of page creation. The format depends on Bitrix24 settings

DATE_MODIFY
datetime

Date and time of the last modification of the page. The format depends on Bitrix24 settings

DATE_PUBLIC
datetime | null

Date and time of page publication. Changing this field does not publish the page by itself. In the response, the value is returned as a string in the portal format or null for a page that has never been published

Field
type

Description

DOMAIN_ID
integer | string

Identifier of the site domain to which the page is linked. The method landing.landing.getList always adds this field to the result

PUBLIC_URL
string | null

Full public URL of the page. Returned in landing.landing.getList if the get_urls flag is enabled, and as a separate value in the method landing.landing.getpublicurl

PREVIEW
string | null

URL or relative path to the page preview. Returned in landing.landing.getList if the get_preview flag is enabled, and as a separate value in the method landing.landing.getpreview

IS_AREA
boolean

Indicator that the page is used as an included area. Returned in landing.landing.getList if the check_area flag is enabled