Get a CRM Form crm.form.get
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:
crmWho can execute the method: a user with the permission to view CRM forms
The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The method crm.form.get returns a CRM form by identifier.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Form identifier. The identifier can be retrieved with crm.form.list |
|
select |
List of fields to return. You can specify an entire section, for example By default, the simple fields are returned: The |
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.form.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":45,"select":["id","name","active","updatedTime","crm","fields"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.form.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":45,"select":["id","name","active","updatedTime","crm","fields"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.form.get
// 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 FormGetResult = {
item: {
id: number
name: string
active: boolean
updatedTime: string
crm: {
entityScheme: number
duplicateMode: string | null
}
fields: Array<{
name: string
type: string
label: string | null
required: boolean
}>
}
}
try {
const response = await $b24.actions.v3.call.make<FormGetResult>({
method: 'crm.form.get',
params: {
id: 45,
select: ['id', 'name', 'active', 'updatedTime', 'crm', 'fields'],
},
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.item)
}
} 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 getForm() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'crm.form.get',
params: {
id: 45,
select: ['id', 'name', 'active', 'updatedTime', 'crm', 'fields'],
},
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.item)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getForm)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
# client = Client(token, prefer_version=3)
try:
bitrix_response = client.crm.form.get(
id=45,
select=["id", "name", "active", "updatedTime", "crm", "fields"],
).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}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
try {
$response = $b24Service
->core
->call(
'crm.form.get',
[
'id' => 45,
'select' => ['id', 'name', 'active', 'updatedTime', 'crm', 'fields'],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
BX24.callMethod(
'crm.form.get',
{
id: 45,
select: ['id', 'name', 'active', 'updatedTime', 'crm', 'fields'],
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
require_once('crest.php');
$result = CRest::call(
'crm.form.get',
[
'id' => 45,
'select' => ['id', 'name', 'active', 'updatedTime', 'crm', 'fields'],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created; the client's base URL contains /rest/api/
res, err := client.Core().Call(ctx, "crm.form.get", b24.Params{
"id": 45,
"select": []string{"id", "name", "active", "updatedTime", "crm", "fields"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.form.get: %w", err)
}
// The method wraps the response in an object with the "item" key.
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("the response has no item key")
}
var form struct {
ID int `json:"id"`
Name string `json:"name"`
Active bool `json:"active"`
UpdatedTime string `json:"updatedTime"`
}
if err := json.Unmarshal(raw, &form); err != nil {
return fmt.Errorf("parsing the response: %w", err)
}
fmt.Println(form.ID, form.Name, form.Active)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 45,
"name": "Contact information",
"active": true,
"updatedTime": "2026-03-11T16:47:17+02:00",
"crm": {
"entityScheme": 1,
"duplicateMode": "MERGE",
"dealCategoryId": null,
"dealDuplicateControlEnabled": true,
"smartProcessCategoryId": null,
"smartProcessDuplicateControlEnabled": false
},
"fields": [
{
"name": "LEAD_NAME",
"type": "string",
"label": "Name",
"sort": 100,
"required": false,
"multiple": false,
"placeholder": "",
"valueType": null,
"value": null
},
{
"name": "LEAD_PHONE",
"type": "phone",
"label": "Phone",
"sort": 300,
"required": false,
"multiple": false,
"placeholder": "",
"valueType": null,
"value": null
}
]
}
},
"time": {
"start": 1792593811,
"finish": 1792593811.215759,
"duration": 0.2157590389251709,
"processing": 0,
"date_start": "2026-10-21T17:43:31+02:00",
"date_finish": "2026-10-21T17:43:31+02:00",
"operating_reset_at": 1792594380,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the response data |
|
item |
Object with the form fields. The set of fields depends on |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 404
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
"message": "Entity with ID 999999 was not found."
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
HTTP status: 400
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass the form identifier |
Errors in the select Parameter
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
HTTP status: 400
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Pass fields from CRM Form Structure |
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION
HTTP status: 400
|
Field |
Error description |
How to Fix |
|
|
Invalid field in |
Pass |
Access Error
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
HTTP status: 403
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Make sure the user has the permission to view CRM forms |
Form Not Found Error
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
HTTP status: 404
|
Field |
Error description |
How to Fix |
|
|
Entity with ID |
Check the identifier with crm.form.list |
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 |