Site Fields
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
Site fields describe the title, address, type, publication status, and system pages of a site. The method landing.site.getList returns these fields, and the methods landing.site.add and landing.site.update accept some of them in the fields parameter.
Additional site fields, such as the theme, background, analytics, and custom code, are not included in this table. They are passed in the ADDITIONAL_FIELDS array and read with the method landing.site.getadditionalfields. They are described in the article Additional Website Fields.
Scope:
landingWho can retrieve the fields: a user with the "view" access permission for sites. Changing the fields requires the "edit settings" access permission for the site
How to Retrieve Site Fields
Pass the names of the fields you need in params.select of the method landing.site.getList. For example, to find a site by its external identifier and retrieve its address and publication status:
{
"params": {
"select": ["ID", "TITLE", "ACTIVE", "PUBLIC_URL"],
"filter": {
"=XML_ID": "my-integration-site-1"
}
}
}
If select is not passed, the method returns all fields from the tables of main and service fields. Calculated fields are returned only if you specify them in select. The method always adds the ID and TYPE fields to the selection.
By default, landing.site.getList returns only sites with the value DELETED = "N". To retrieve sites from the trash, pass DELETED or =DELETED in filter.
What You Need to Know
- When created via
landing.site.add, the site is created unpublished with the valueACTIVE = "N". - The methods
landing.site.addandlanding.site.updatedo not save theACTIVE,SPECIAL, andTPL_CODEfields: values fromfieldsare ignored without an error. Publication is managed by the methods landing.site.publication and landing.site.unpublic. - 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.
- Bitrix24 fills in the
CREATED_BY_ID,MODIFIED_BY_ID,DATE_CREATE, andDATE_MODIFYfields automatically when a site is created or updated.
Main Fields
|
Field |
Description |
|
ID |
Site identifier. The field is always present in the response of |
|
TITLE |
Site title. This field is required when creating a site |
|
CODE |
Symbolic code of the site. In the response of |
|
TYPE |
Type of the site. Possible values: Default is For more details on types and internal scopes, read the article Working with Site Types and Scopes |
|
ACTIVE |
Site publication status. Possible values: When created via |
|
DELETED |
Trash flag. Possible values: By default, |
|
DESCRIPTION |
Brief description of the site. Displayed in the list of sites |
|
XML_ID |
External identifier of the site. It is convenient for finding the site from an integration without storing the internal |
|
Domain identifier. The domain name is returned by the calculated field |
|
|
LANG |
Two-letter code of the site's language zone, for example |
|
TPL_ID |
Identifier of the view template of the site |
|
LANDING_ID_INDEX |
Identifier of the main page of the site. This field is also used to obtain |
|
LANDING_ID_404 |
Identifier of the |
|
LANDING_ID_503 |
Identifier of the |
|
CREATED_BY_ID |
Identifier of the user who created the site |
|
MODIFIED_BY_ID |
Identifier of the user who last modified the site |
|
DATE_CREATE |
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 |
|
DATE_MODIFY |
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 |
Service Fields
Bitrix24 fills in these fields itself. The method landing.site.getList returns them when requested without select or when they are explicitly specified in select. You do not need to pass them to landing.site.add and landing.site.update.
|
Field |
Description |
|
TPL_CODE |
Code of the template of the preset solution the site was created from, for example |
|
SPECIAL |
Technical site indicator. Possible values: Default is |
|
SMN_SITE_ID |
Identifier of the main module site the site is linked to. If there is no link, |
|
VERSION |
Internal version of the site |
Calculated Fields
These fields are not stored in the site table. The method landing.site.getList generates them in the response.
|
Field |
Description |
|
DOMAIN_NAME |
Domain name of the site. Returned if the field is specified in |
|
PUBLIC_URL |
Full public URL of the site. It may be an empty string if the URL could not be determined. Returned if the field is specified in |
|
PREVIEW_PICTURE |
URL of the preview of the main page of the site. It may be an empty string if the preview is unavailable. Returned if the field is specified in |
|
PHONE |
Phone number of the CRM contact associated with the site. Returned if the field is specified in |
|
DATE_CREATE_ISO |
Date and time of site creation in ISO 8601 format, for example |
|
DATE_MODIFY_ISO |
Date and time of the last modification of the site in ISO 8601 format. Returned together with |
Continue Your Learning
- create a site and change its fields — Add site landing.site.add, Update Site landing.site.update
- retrieve a list of sites with selected fields — Get the List of Sites landing.site.getList
- publish or unpublish a site — Publish the site landing.site.publication, Unpublishing a Site landing.site.unpublic
- retrieve the public address and preview of a site — Get Public URL of the Site landing.site.getPublicUrl, Get URL Preview of the Site landing.site.getPreview
- work with additional site fields — Additional Website Fields, Get Additional Fields of the Site landing.site.getadditionalfields
- choose a site type and internal scope — Working with Site Types and Scopes