Get Custom Type Fields crm.type.fields
Scope:
crmWho can execute the method: any user with administrative access to the CRM section
This method retrieves information about the custom fields of the smart process settings.
No parameters.
Examples
How to Use Examples in Documentation
Get information about the smart process fields
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**/crm.type.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/crm.type.fields?auth=**put_access_token_here**
try
{
const response = await $b24.callMethod(
'crm.type.fields',
{}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.type.fields',
[]
);
$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 fetching CRM type fields: ' . $e->getMessage();
}
BX24.callMethod(
'crm.type.fields',
{},
(result) => {
if (result.error())
{
console.error(result.error());
return;
}
console.info(result.data());
},
);
require_once('crest.php');
$result = CRest::call(
'crm.type.fields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"fields": {
"id": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID",
"upperName": "ID"
},
"title": {
"type": "string",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Title",
"upperName": "TITLE"
},
"code": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Symbolic Code",
"upperName": "CODE"
},
"createdBy": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Created By",
"upperName": "CREATED_BY"
},
"entityTypeId": {
"type": "integer",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Type Identifier",
"upperName": "ENTITY_TYPE_ID"
},
"customSectionId": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Digital Workspace",
"upperName": "CUSTOM_SECTION_ID"
},
"isCategoriesEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Use custom funnels and sales tunnels in the smart process",
"upperName": "IS_CATEGORIES_ENABLED"
},
"isStagesEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Use custom stages and Kanban in the smart process",
"upperName": "IS_STAGES_ENABLED"
},
"isBeginCloseDatesEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Fields 'Start Date' and 'End Date'",
"upperName": "IS_BEGIN_CLOSE_DATES_ENABLED"
},
"isClientEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Field 'Client'",
"upperName": "IS_CLIENT_ENABLED"
},
"isUseInUserfieldEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Use in user field",
"upperName": "IS_USE_IN_USERFIELD_ENABLED"
},
"isLinkWithProductsEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Link with catalog products",
"upperName": "IS_LINK_WITH_PRODUCTS_ENABLED"
},
"isMycompanyEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Field 'Your Company Details'",
"upperName": "IS_MYCOMPANY_ENABLED"
},
"isDocumentsEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Document Printing",
"upperName": "IS_DOCUMENTS_ENABLED"
},
"isSourceEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Fields 'Source' and 'Additional Information about Source'",
"upperName": "IS_SOURCE_ENABLED"
},
"isObserversEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Field 'Observers'",
"upperName": "IS_OBSERVERS_ENABLED"
},
"isRecyclebinEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Use Recycle Bin",
"upperName": "IS_RECYCLEBIN_ENABLED"
},
"isAutomationEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Use Automation rules and triggers in the smart process",
"upperName": "IS_AUTOMATION_ENABLED"
},
"isBizProcEnabled": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Use business process designer in the smart process",
"upperName": "IS_BIZ_PROC_ENABLED"
},
"isSetOpenPermissions": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Make new funnels available to everyone",
"upperName": "IS_SET_OPEN_PERMISSIONS"
},
"createdTime": {
"type": "datetime",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Creation Date",
"upperName": "CREATED_TIME"
},
"updatedTime": {
"type": "datetime",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Modification Date",
"upperName": "UPDATED_TIME"
},
"updatedBy": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Modified By",
"upperName": "UPDATED_BY"
}
}
},
"time": {
"start": 1720436891.554676,
"finish": 1720436894.393655,
"duration": 2.8389790058135986,
"processing": 0.20139384269714355,
"date_start": "2024-07-08T13:08:11+02:00",
"date_finish": "2024-07-08T13:08:14+02:00",
"operating": 0
}
}
Returned Data
|
Title |
Description |
|
result |
Root element of the response. Contains an object with a single key |
|
fields |
Object in the format: |
|
time |
Object containing information about the request execution time |
Error Handling
HTTP status: 400, 403
{
"error": "ACCESS_DENIED",
"error_description": "Access Denied"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
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 |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Smart Processes: Overview of Methods
- Create a new custom type crm.type.add
- Update User Type crm.type.update
- Get the user type by id crm.type.get
- Get the user type by entityTypeId crm.type.getByEntityTypeId
- Get a list of custom types crm.type.list
- Delete user type crm.type.delete