Site Fields

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Site fields are used in the method landing.site.getList.

Some fields can be passed when creating and updating a site through the methods landing.site.add and landing.site.update.

Additional site fields are passed separately in the ADDITIONAL_FIELDS array and can be read through landing.site.getadditionalfields.

What You Need to Know

  • When created via landing.site.add, the site is created unpublished with the value ACTIVE = N.
  • If the site is moved to the trash, it is automatically unpublished.
  • To delete and restore a site, use landing.site.markDelete and landing.site.markUnDelete.
  • System fields may appear in the response of landing.site.getList, but they are not set manually.

Main Fields

Field
type

Description

ID
integer

Site identifier. The field is always present in the response of landing.site.getList

TITLE
string

Site title. This field is required when creating a site

CODE
string

Symbolic code of the site. In the response of landing.site.getList, it is returned in the format /code/. When creating and updating, you can pass the value without the outer /. If an empty string is passed, the code will be generated from TITLE or from the string site. A code consisting of only digits receives the prefix site

TYPE
string

Type of the site.

Possible values:
PAGE site
STORE store
SMN project
KNOWLEDGE knowledge base
GROUP group site
MAINPAGE main page or vibe

Default is PAGE.

For more details on types and internal scopes, read the article Working with Site Types and Scopes

ACTIVE
string

Site publication status.

Possible values:
Y site is published
N site is not published

When created via landing.site.add, the site receives the value N. To publish and unpublish, use landing.site.publication and landing.site.unpublic

DELETED
string

Trash flag.

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

By default, landing.site.getList returns only sites with the value DELETED = "N"

DESCRIPTION
string

Brief description of the site. Displayed in the list of sites

XML_ID
string

External identifier of the site

DOMAIN_ID
integer | string

Domain identifier

LANG
string

Two-letter code of the site's language zone, for example de, en, fr, it, es, jp

TPL_ID
integer

Identifier of the view template of the site

LANDING_ID_INDEX
integer

Identifier of the main page of the site. This field is also used to obtain PREVIEW_PICTURE

LANDING_ID_404
integer

Identifier of the 404 error page

LANDING_ID_503
integer

Identifier of the 503 error page

CREATED_BY_ID
integer

Identifier of the user who created the site

MODIFIED_BY_ID
integer

Identifier of the user who last modified the site

DATE_CREATE
datetime

Date and time of site creation. In the REST response, it is returned as a string. The format depends on the portal's regional settings, for example 04/20/2020 12:48:10 pm

DATE_MODIFY
datetime

Date and time of the last modification of the site. In the REST response, it is returned as a string. The format depends on the portal's regional settings, for example 04/20/2020 12:48:10 pm

Calculated Fields

These fields are not stored in the site table. The method landing.site.getList returns them when requested in select.

Field
type

Description

DOMAIN_NAME
string

Domain name of the site

PUBLIC_URL
string

Full public URL of the site. It may be an empty string if the URL could not be determined

PREVIEW_PICTURE
string

URL of the preview of the main page of the site. It may be an empty string if the preview is unavailable

PHONE
string | null

Phone number of the CRM contact associated with the site

Continue Your Learning

Previous
Overview of Methods
Next
Additional Fields