Get Public URL of the Site landing.site.getPublicUrl

Scope: landing

Who can execute the method: a user with access to the "Sites and Stores" section

The method landing.site.getPublicUrl returns the complete public URL of a site or multiple sites.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer | array

Identifier of the site or an array of site identifiers. If a single identifier is provided, the result will return a URL string.

If an array of identifiers is provided, the result will return an object of the form {"<ID>": "<URL>"} only for the found sites.

The site identifier can be obtained using the method landing.site.getList or from the result of the method landing.site.add

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": [3, 135]
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.getPublicUrl.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": [3, 135],
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.site.getPublicUrl.json"

try
        {
        	const response = await $b24.callMethod(
        		'landing.site.getPublicUrl',
        		{
        			id: [3, 135]
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.site.getPublicUrl',
                    [
                        'id' => [3, 135],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting public URL: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.site.getPublicUrl',
            {
                id: [3, 135]
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.site.getPublicUrl',
            [
                'id' => [3, 135],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Response Handling

HTTP Status: 200

{
            "result": {
                "3": "https://vilka.bitrix24.site",
                "135": "https://b24-odhzt3.bitrix24site.com"
            },
            "time": {
                "start": 1773277610,
                "finish": 1773277611.040785,
                "duration": 1.0407850742340088,
                "processing": 0,
                "date_start": "2026-03-12T04:06:50+01:00",
                "date_finish": "2026-03-12T04:06:51+01:00",
                "operating_reset_at": 1773278211,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
string | object | array

The result depends on the type of the input parameter id.

If a single id is provided, the method returns a string with the site URL. If an array of id is provided, the method returns an object of the form {"<ID>": "<URL>"} (detailed description).

If the site is not found, an empty string "" is returned for a single id, and an empty array [] may be returned for an array of id

time
time

Information about the execution time of the request

Result Object for Array of IDs

Name `type`	Description
`string`	Complete public URL of the site. The URL may be returned without a trailing `/`

Error Handling

HTTP Status: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Insufficient call parameters, missing: id"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description
`MISSING_PARAMS`	The required parameter `id` was not provided
`ACCESS_DENIED`	Insufficient permissions to call the method
`TYPE_ERROR`	Data type error in the method call parameters
`SYSTEM_ERROR`	Internal error during method execution

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Get Site Preview URL

Get Additional Fields

Get Public URL of the Site landing.site.getPublicUrl

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result Object for Array of IDsResult Object for Array of IDs

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning