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:
basicWho 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 |
Description |
|
result |
Information about the application (detailed description) |
|
time |
Information about the request execution time |
Result Object
|
Name |
Description |
|
ID |
Local identifier of the application in Bitrix24 |
|
CODE |
Application code |
|
VERSION |
Installed version of the application |
|
STATUS |
Status of the application:
|
|
INSTALLED |
Whether the application installation is complete. If |
|
PAYMENT_EXPIRED |
Whether the paid period has expired: |
|
DAYS |
Number of days until the end of the paid or trial period. After the period ends, a negative number.
|
|
LANGUAGE_ID |
Default language of the Bitrix24 site, for example |
|
LICENSE |
Bitrix24 plan with a region prefix, for example
In on-premise Bitrix24, it is the string |
|
LICENSE_PREVIOUS |
The plan that was active before the demo mode, in the |
|
LICENSE_TYPE |
Plan identifier without the region prefix, for example |
|
LICENSE_FAMILY |
Plan family, for example |
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 |
Description |
|
SCOPE |
Webhook scope codes, as in the scope method |
|
LICENSE |
Bitrix24 plan, in the same format as the |
Error Handling
HTTP status: 403
{
"error": "ACCESS_DENIED",
"error_description": "Access denied! Application context required"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |