Get a List of Available Application Embed Locations placement.list

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.

Scope: placement

Who can execute the method: a user authorized in the application

The method placement.list returns a list of available embed locations for the application.

The method works only in the context of the application.

Method Parameters

Required parameters are marked with *

Name
type

Description

SCOPE
string

Limits the list of embed locations to a specific application scope.

If the parameter is provided and not empty, the method returns embed locations only for the specified scope.

FULL
boolean

Flag to retrieve the full list of embed locations.

If the parameter is not provided or is set to false, the method returns embed locations for the current application's scope and global embed locations.

If the parameter is set to true, the method returns embed locations for all service scopes.

The parameter is considered only if SCOPE is not provided.

Code Examples

How to Use Examples in Documentation

Example of retrieving a list of embed locations available for the application, where:

  • SCOPE — the application's scope for which embed locations are needed.
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "SCOPE": "crm",
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/placement.list.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'placement.list',
        		{
        			SCOPE: 'crm'
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.list',
                    [
                        'SCOPE' => 'crm',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting placement list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'placement.list',
            {
                SCOPE: 'crm'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
$result = CRest::call(
            'placement.list',
            [
                'SCOPE' => 'crm',
            ]
        );
        
        echo '<pre>';
        print_r($result);
        echo '</pre>';

Response Handling

HTTP Status: 200

{
            "result": [
                "CRM_DEAL_LIST_TOOLBAR",
                "CRM_LEAD_LIST_TOOLBAR",
                "CRM_CONTACT_LIST_TOOLBAR",
                "CRM_COMPANY_LIST_TOOLBAR",
                "CRM_INVOICE_LIST_TOOLBAR",
                "CRM_QUOTE_LIST_TOOLBAR",
                "CRM_ORDER_LIST_TOOLBAR",
                "CRM_DYNAMIC_136_LIST_TOOLBAR",
                "CRM_DYNAMIC_1038_LIST_TOOLBAR",
                "CRM_SMART_INVOICE_LIST_TOOLBAR",
                "CRM_DEAL_DETAIL_TOOLBAR",
                "CRM_LEAD_DETAIL_TOOLBAR",
                "CRM_CONTACT_DETAIL_TOOLBAR",
                "CRM_COMPANY_DETAIL_TOOLBAR",
                "CRM_INVOICE_DETAIL_TOOLBAR",
                "CRM_QUOTE_DETAIL_TOOLBAR",
                "CRM_DYNAMIC_136_DETAIL_TOOLBAR",
                "CRM_DYNAMIC_1038_DETAIL_TOOLBAR",
                "CRM_SMART_INVOICE_DETAIL_TOOLBAR",
                "CRM_DEAL_ACTIVITY_TIMELINE_MENU",
                "CRM_LEAD_ACTIVITY_TIMELINE_MENU",
                "CRM_QUOTE_ACTIVITY_TIMELINE_MENU"
            ],
            "time": {
                "start": 1712132792.910734,
                "finish": 1712132793.530359,
                "duration": 0.6196250915527344,
                "processing": 0.032338857650756836,
                "date_start": "2024-04-03T10:26:32+02:00",
                "date_finish": "2024-04-03T10:26:33+02:00",
                "operating_reset_at": 1705765533,
                "operating": 3.3076241016387939
            }
        }

Returned Data

Name
type

Description

result
string[]

A list of codes for embed locations available for the application.

Each element of the array is a string code for an embed location.

time
time

Information about the execution time of the request.

Error Handling

HTTP Status: 403

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Current authorization type is denied for this method Application context required"
        }

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

Status

Code

Description

Value

403

WRONG_AUTH_TYPE

Current authorization type is denied for this method Application context required

Method call not from application context.

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 permitted for calls 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 HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only

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 "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

Continue Learning

Previous
Get a List of Registered Widgets
Next
Unregister a Widget