метод REST
scope: crm
crm.type.get
Получить пользовательский тип по id
Описание
Метод получает информацию о смарт-процессе с идентификатором id.
Параметры
id
integer
обязательный
Идентификатор смарт-процесса. Можно получить с помощью методов: crm.type.list, crm.type.add
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":16}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":16,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.type.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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type TypeGetResult = {
type: {
id: number
title: string
code: string
createdBy: number
entityTypeId: number
customSectionId: number | null
isCategoriesEnabled: 'Y' | 'N'
isStagesEnabled: 'Y' | 'N'
isBeginCloseDatesEnabled: 'Y' | 'N'
isClientEnabled: 'Y' | 'N'
isUseInUserfieldEnabled: 'Y' | 'N'
isLinkWithProductsEnabled: 'Y' | 'N'
isMycompanyEnabled: 'Y' | 'N'
isDocumentsEnabled: 'Y' | 'N'
isSourceEnabled: 'Y' | 'N'
isObserversEnabled: 'Y' | 'N'
isRecyclebinEnabled: 'Y' | 'N'
isAutomationEnabled: 'Y' | 'N'
isBizProcEnabled: 'Y' | 'N'
isSetOpenPermissions: 'Y' | 'N'
isPaymentsEnabled: 'Y' | 'N'
isCountersEnabled: 'Y' | 'N'
createdTime: ISODate | null
updatedTime: ISODate | null
updatedBy: number
relations: {
parent: { entityTypeId: number; isChildrenListEnabled: 'Y' | 'N'; isPredefined: 'Y' | 'N' }[]
child: { entityTypeId: number; isChildrenListEnabled: 'Y' | 'N'; isPredefined: 'Y' | 'N' }[]
}
linkedUserFields: Record<string, 'Y' | 'N'>
customSections: unknown[]
}
}
try {
const response = await $b24.actions.v2.call.make<TypeGetResult>({
method: 'crm.type.get',
params: {
id: 16,
},
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, result.type.entityTypeId)
}
} 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 getType() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.type.get',
params: {
id: 16,
},
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, result.type.entityTypeId)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getType)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.type.get(
bitrix_id=20,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.type.get',
[
'id' => 16,
]
);
$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 CRM type: ' . $e->getMessage();
}
BX24.callMethod(
'crm.type.get',
{
id: 16,
},
(result) => {
if (result.error())
{
console.error(result.error());
return;
}
console.info(result.data());
},
);
require_once('crest.php');
$result = CRest::call(
'crm.type.get',
[
'id' => 16
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.type.get", b24.Params{
"id": 16,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.type.get: %w", err)
}
// Метод заворачивает ответ в объект с ключом "type".
raw, ok := b24.Unwrap(res.Result, "type")
if !ok {
return fmt.Errorf("в ответе нет ключа type")
}
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("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Title)
Ответ
HTTP-статус: 200
{
"result": {
"type": {
"id": 16,
"title": "Смарт-процесс",
"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
}
}
Возвращаемые данные
result
object
Корневой элемент ответа, содержащий объект type с информацией о смарт-процессе
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": 0,
"error_description": "Смарт-процесс не найден"
}
| Код | Описание | Значение |
|---|---|---|
403 |
allowed_only_intranet_user |
Действие разрешено только интранет-пользователям |
400 |
ACCESS_DENIED |
Доступ запрещен |
400 |
0 |
Смарт-процесс не найден |

