Get the user type by entityTypeId crm.type.getByEntityTypeId
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: any user with administrative access to the SPA, or a user with read access to the SPA
The method retrieves information about the SPA with the smart process type identifier entityTypeId.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
entityTypeId* |
Identifier of the smart process type. |
Code Examples
Retrieve information about the smart process with entityTypeId = 2024.
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2024}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.getByEntityTypeId
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2024,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.type.getByEntityTypeId
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type CrmTypeGetByEntityTypeIdResult = {
type: {
id: number
title: string
code: string
createdBy: number
entityTypeId: number
customSectionId: number | null
isCategoriesEnabled: string
isStagesEnabled: string
isBeginCloseDatesEnabled: string
isClientEnabled: string
isUseInUserfieldEnabled: string
isLinkWithProductsEnabled: string
isMycompanyEnabled: string
isDocumentsEnabled: string
isSourceEnabled: string
isObserversEnabled: string
isRecyclebinEnabled: string
isAutomationEnabled: string
isBizProcEnabled: string
isSetOpenPermissions: string
isPaymentsEnabled: string
isCountersEnabled: string
createdTime: ISODate
updatedTime: ISODate
updatedBy: number
relations: {
parent: Array<{
entityTypeId: number
isChildrenListEnabled: string
isPredefined: string
}>
child: Array<{
entityTypeId: number
isChildrenListEnabled: string
isPredefined: string
}>
}
linkedUserFields: Record<string, string>
customSections: unknown[]
}
}
try {
const response = await $b24.actions.v2.call.make<CrmTypeGetByEntityTypeIdResult>({
method: 'crm.type.getByEntityTypeId',
params: {
entityTypeId: 2024,
},
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.type.id, result.type.title)
}
} 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 getTypeByEntityTypeId() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.type.getByEntityTypeId',
params: {
entityTypeId: 2024,
},
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.type.id, result.type.title)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTypeByEntityTypeId)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.type.get_by_entity_type_id(
entity_type_id=1222,
).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 {
$response = $b24Service
->core
->call(
'crm.type.getByEntityTypeId',
[
'entityTypeId' => 2024,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
return;
}
echo 'Success: ' . print_r($result->data(), true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting entity types: ' . $e->getMessage();
}
BX24.callMethod(
'crm.type.getByEntityTypeId',
{
entityTypeId: 2024,
},
(result) => {
if (result.error())
{
console.error(result.error());
return;
}
console.info(result.data());
},
);
require_once('crest.php');
$result = CRest::call(
'crm.type.getByEntityTypeId',
[
'entityTypeId' => 2024
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.type.getByEntityTypeId", b24.Params{
"entityTypeId": 2024,
})
if err != nil {
return fmt.Errorf("crm.type.getByEntityTypeId: %w", err)
}
// The method wraps the response in an object with the "type" key.
raw, ok := b24.Unwrap(res.Result, "type")
if !ok {
return fmt.Errorf("no type key in the response")
}
var item struct {
ID b24.ID `json:"id"`
Title string `json:"title"`
Code string `json:"code"`
CreatedBy int `json:"createdBy"`
EntityTypeID b24.ID `json:"entityTypeId"`
IsCategoriesEnabled string `json:"isCategoriesEnabled"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.Title)
Response Handling
HTTP Status: 200
{
"result": {
"type": {
"id": 16,
"title": "Smart Process",
"code": "",
"createdBy": 1,
"entityTypeId": 2024,
"customSectionId": null,
"isCategoriesEnabled": "Y",
"isStagesEnabled": "Y",
"isBeginCloseDatesEnabled": "Y",
"isClientEnabled": "Y",
"isUseInUserfieldEnabled": "Y",
"isLinkWithProductsEnabled": "Y",
"isMycompanyEnabled": "Y",
"isDocumentsEnabled": "Y",
"isSourceEnabled": "Y",
"isObserversEnabled": "Y",
"isRecyclebinEnabled": "Y",
"isAutomationEnabled": "Y",
"isBizProcEnabled": "Y",
"isSetOpenPermissions": "Y",
"isPaymentsEnabled": "N",
"isCountersEnabled": "N",
"createdTime": "2024-07-08T14:46:54+02:00",
"updatedTime": "2024-07-08T14:46:54+02:00",
"updatedBy": 1,
"relations": {
"parent": [
{
"entityTypeId": 3,
"isChildrenListEnabled": "Y",
"isPredefined": "Y"
},
{
"entityTypeId": 4,
"isChildrenListEnabled": "Y",
"isPredefined": "Y"
},
{
"entityTypeId": 1,
"isChildrenListEnabled": "Y",
"isPredefined": "N"
},
{
"entityTypeId": 2,
"isChildrenListEnabled": "Y",
"isPredefined": "N"
},
{
"entityTypeId": 31,
"isChildrenListEnabled": "Y",
"isPredefined": "N"
}
],
"child": [
{
"entityTypeId": 3,
"isChildrenListEnabled": "Y",
"isPredefined": "N"
},
{
"entityTypeId": 4,
"isChildrenListEnabled": "N",
"isPredefined": "N"
}
]
},
"linkedUserFields": {
"CALENDAR_EVENT|UF_CRM_CAL_EVENT": "Y",
"TASKS_TASK|UF_CRM_TASK": "Y",
"TASKS_TASK_TEMPLATE|UF_CRM_TASK": "N"
},
"customSections": []
}
},
"time": {
"start": 1720442829.865672,
"finish": 1720442830.334845,
"duration": 0.46917295455932617,
"processing": 0.13246917724609375,
"date_start": "2024-07-08T14:47:09+02:00",
"date_finish": "2024-07-08T14:47:10+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response containing the |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": 0,
"error_description": "Smart process not found"
}
|
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 |
|
|
|
Action allowed only for intranet users |
Occurs if the user is not an intranet user |
|
|
|
Access denied |
Occurs if the user does not have administrative rights in CRM or does not have read access to the SPA |
|
|
|
Smart process not found |
Smart process with the provided |
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 |