Get the user type by id crm.type.get
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 identifier id.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the SPA. Can be obtained using the methods: |
Code Examples
Get information about the SPA with id = 16.
How to Use Examples in Documentation
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
try
{
const response = await $b24.callMethod(
'crm.type.get',
{
id: 16,
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(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>';
Response Handling
HTTP status: 200
{
"result": {
"type": {
"id": 16,
"title": "SPA",
"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 object |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": 0,
"error_description": "SPA not found"
}
|
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 or does not have read access to the SPA |
|
|
|
SPA not found |
SPA with the provided |
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 entityTypeId crm.type.getByEntityTypeId
- Get a list of custom types crm.type.list
- Delete user type crm.type.delete
- Get Custom Type Fields crm.type.fields