Show information about the app app.info

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

Scope: basic

Who can execute the method: any user

The method app.info returns information about the application: its status, version, payment period, and Bitrix24 plan. See also the response when called via a webhook.

Method Parameters

No parameters.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/app.info
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/app.info
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type AppInfoResult = {
          ID: number
          CODE: string
          VERSION: number
          STATUS: string
          INSTALLED: boolean
          PAYMENT_EXPIRED: string
          DAYS: number | null
          LANGUAGE_ID: string
          LICENSE: string
          LICENSE_PREVIOUS?: string
          LICENSE_TYPE?: string
          LICENSE_FAMILY?: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<AppInfoResult>({
            method: 'app.info',
            params: {},
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info(result.ID, result.CODE, result.STATUS, result.LICENSE)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getAppInfo() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'app.info',
                params: {},
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info(result.ID, result.CODE, result.STATUS, result.LICENSE)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getAppInfo)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.app.info().response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $applicationInfoResult = $serviceBuilder->getMainScope()->main()->getApplicationInfo();
            $itemResult = $applicationInfoResult->applicationInfo();
            print("ID: " . $itemResult->ID . PHP_EOL);
            print("Code: " . $itemResult->CODE . PHP_EOL);
            print("Version: " . $itemResult->VERSION . PHP_EOL);
            print("Status: " . $itemResult->getStatus()->getStatusCode() . PHP_EOL);
            print("Installed: " . ($itemResult->INSTALLED ? 'true' : 'false') . PHP_EOL);
            print("Payment Expired: " . $itemResult->PAYMENT_EXPIRED . PHP_EOL);
            print("Days: " . $itemResult->DAYS . PHP_EOL);
            print("License: " . $itemResult->LICENSE . PHP_EOL);
        } catch (Throwable $e) {
            print("Error: " . $e->getMessage() . PHP_EOL);
        }
        
BX24.callMethod(
            "app.info",
            {},
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'app.info',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "app.info", nil)
        if err != nil {
        	return fmt.Errorf("app.info: %w", err)
        }
        
        var item struct {
        	ID             b24.ID `json:"ID"`
        	Code           string `json:"CODE"`
        	Version        int    `json:"VERSION"`
        	Status         string `json:"STATUS"`
        	Installed      bool   `json:"INSTALLED"`
        	PaymentExpired string `json:"PAYMENT_EXPIRED"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Code)
        

Response Handling

HTTP status: 200

{
            "result": {
                "ID": 5,
                "CODE": "telefum24.kp10",
                "VERSION": 4,
                "STATUS": "F",
                "INSTALLED": true,
                "PAYMENT_EXPIRED": "N",
                "DAYS": null,
                "LANGUAGE_ID": "de",
                "LICENSE": "de_ent10000",
                "LICENSE_TYPE": "ent10000",
                "LICENSE_FAMILY": "ent"
            },
            "time": {
                "start": 1722841503.0585,
                "finish": 1722841503.09885,
                "duration": 0.0403509140014648,
                "processing": 0.00533103942871094,
                "date_start": "2024-08-05T07:05:03+00:00",
                "date_finish": "2024-08-05T07:05:03+00:00",
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Information about the application (detailed description)

time
time

Information about the request execution time

Result Object

Name
type

Description

ID
integer

Local identifier of the application in Bitrix24

CODE
string

Application code

VERSION
integer

Installed version of the application

STATUS
string

Status of the application:

  • L — local application
  • F — free mass-market application
  • D — demo version of a mass-market application
  • T — trial version of a mass-market application, time-limited
  • P — paid mass-market application

INSTALLED
boolean

Whether the application installation is complete. If false, the application is only available to Bitrix24 administrators and must report the end of installation by calling BX24.installFinish. While the value is false, Bitrix24 does not deliver events to the application and does not show its placements, even if event.bind and placement.bind succeeded

PAYMENT_EXPIRED
string

Whether the paid period has expired: Y or N

DAYS
integer

Number of days until the end of the paid or trial period. After the period ends, a negative number.

null if the period is not limited, for example, for a free or local application

LANGUAGE_ID
string

Default language of the Bitrix24 site, for example de

LICENSE
string

Bitrix24 plan with a region prefix, for example de_std. For plans whose composition changed while the name stayed the same, such as CRM+, Team, and Company, this field does not show which plan is active. Examples of values:

  • de_project — Project plan
  • de_basic — Basic plan
  • de_std — Standard plan
  • de_pro100 — Professional plan
  • de_ent250 — Enterprise 250
  • de_ent500 — Enterprise 500
  • de_ent1000 — Enterprise 1000
  • de_ent2000 — Enterprise 2000
  • de_ent10000 — Enterprise 10000

In on-premise Bitrix24, it is the string <language>_selfhosted, for example, en_selfhosted

LICENSE_PREVIOUS
string

The plan that was active before the demo mode, in the LICENSE format. Returned only if Bitrix24 is currently in the plan's demo mode

LICENSE_TYPE
string

Plan identifier without the region prefix, for example ent10000. Cloud Bitrix24 only

LICENSE_FAMILY
string

Plan family, for example ent. Cloud Bitrix24 only

When the paid period has expired, the PAYMENT_EXPIRED field equals Y. If the end date of the period is known, the DAYS field contains a negative number — the number of days since the period ended.

Response When Called via a Webhook

When called via a webhook, the method does not return application data; instead, it returns the webhook's scopes and the Bitrix24 plan:

{
            "result": {
                "SCOPE": [
                    "crm",
                    "user"
                ],
                "LICENSE": "de_std"
            },
            "time": {
                "start": 1790665588,
                "finish": 1790665588.741944,
                "duration": 0.7419440746307373,
                "processing": 0,
                "date_start": "2026-09-29T09:06:28+02:00",
                "date_finish": "2026-09-29T09:06:28+02:00",
                "operating_reset_at": 1790666188,
                "operating": 0.11118412017822266
            }
        }
        

Name
type

Description

SCOPE
string[]

Webhook scope codes, as in the scope method

LICENSE
string

Bitrix24 plan, in the same format as the LICENSE field above

Error Handling

HTTP status: 403

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied! Application context required"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

403

ACCESS_DENIED

Access denied! Application context required

The request is authorized by a user session rather than by an application or a webhook

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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