Get a CRM Directory Value v 3.0 crm.dictionary.[directory].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 permission to view leads, deals, or other CRM objects
This 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 crm.dictionary.<directory>.get method returns a single CRM directory value by ID. The directory is set by the <directory> segment of the method name.
Method Name for the Directory
|
Directory |
Method |
|
Deal types |
|
|
Contact types |
|
|
Company types |
|
|
Salutations |
|
|
Number of employees |
|
|
Industries |
|
|
Sources |
|
|
Phone types |
|
|
Email types |
|
|
Website types |
|
|
Messenger types |
|
|
Address types |
|
|
CRM object types |
|
|
Stage groups |
|
|
Activity providers |
|
The method name is written in lowercase: crm.dictionary.dealtype.get, not crm.dictionary.dealType.get. If the name is written in a different case or contains an unknown directory, the method returns the "Method Not Found" error.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Value ID, for example, IDs are returned by the crm.dictionary.<directory>.list method |
|
select |
List of fields to return. Each directory has its own set of fields, which is described on the crm.dictionary.<directory>.list page. If the parameter is not passed or an empty array is passed, the method returns all fields |
In CRM value directories, that is, the directories whose values can be changed, for example, dealtype or source, the ID is case-insensitive: sale finds SALE. In the other directories, pass the ID in the same case as in the response of the crm.dictionary.<directory>.list method.
The entitytype directory contains no SPAs. For an SPA type ID, for example, 1038, the crm.dictionary.entitytype.get method returns the "Value Not Found" error. SPA type IDs are returned by the crm.type.list method.
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.dictionary.dealtype.get
The examples retrieve the name of the SALE deal type and the default value flag. For a different directory, replace the method name according to the table above, take id from the response of the crm.dictionary.<directory>.list method, and check the fields in select against the directory field descriptions.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":"SALE","select":["id","name","isSystem"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.dictionary.dealtype.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":"SALE","select":["id","name","isSystem"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.dictionary.dealtype.get
CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.
import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type DictionaryGetResult = {
item: {
id: string
name: string
isSystem: boolean
}
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<DictionaryGetResult>(
'crm.dictionary.dealtype.get',
{
id: 'SALE',
select: ['id', 'name', 'isSystem'],
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Deal type:', result.item.name)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getDealType() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.dictionary.dealtype.get',
{
id: 'SALE',
select: ['id', 'name', 'isSystem'],
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Deal type:', result.item.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDealType)
</script>
b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.
from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError
method = "crm.dictionary.dealtype.get"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"id": "SALE",
"select": ["id", "name", "isSystem"],
},
prefer_version=3,
)
item = response["result"]["item"]
print(item["id"], item["name"], item["isSystem"])
except BitrixAPIError as error:
print(
"Bitrix API error",
f"code: {error.code}",
f"message: {error.error.message}",
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.dictionary.dealtype.get',
[
'id' => 'SALE',
'select' => ['id', 'name', 'isSystem'],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $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.dictionary.dealtype.get',
{
id: 'SALE',
select: ['id', 'name', 'isSystem'],
},
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.dictionary.dealtype.get',
[
'id' => 'SALE',
'select' => ['id', 'name', 'isSystem'],
]
);
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.dictionary.dealtype.get", b24.Params{
"id": "SALE",
"select": []string{"id", "name", "isSystem"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.dictionary.dealtype.get: %w", err)
}
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("response has no item key")
}
var item struct {
ID string `json:"id"`
Name string `json:"name"`
IsSystem bool `json:"isSystem"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.Name, item.IsSystem)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": "SALE",
"name": "Sales",
"isSystem": true
}
},
"time": {
"start": 1793715633,
"finish": 1793715633.516648,
"duration": 0.5166480541229248,
"processing": 0,
"date_start": "2026-11-03T17:20:33+03:00",
"date_finish": "2026-11-03T17:20:33+03:00",
"operating_reset_at": 1793716200,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with response data |
|
result.item |
Directory value. The set of fields is defined by the |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
"message": "Entity with ID SUBSCRIPTION 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
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass |
|
|
Field value must not be empty |
Pass a non-empty ID |
|
|
This request requires data type |
An error of the |
Value Not Found
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Entity with ID |
Check the ID with the crm.dictionary.<directory>.list method. The value may belong to a different directory: |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Check the field name in |
Access Denied
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION, HTTP status: 403
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Call the method on behalf of a user with permission to view leads, deals, or other CRM objects |
Method Not Found
Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404
|
Field |
Error description |
How to Fix |
|
|
Method |
Check the method name: it is written in lowercase, for example, |
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 |
Continue Learning
- CRM Directories in REST 3.0: Overview of Methods
- Add a CRM Directory Value v 3.0 crm.dictionary.[directory].add
- Update a CRM Directory Value v 3.0 crm.dictionary.[directory].update
- Get a List of CRM Directory Values v 3.0 crm.dictionary.[directory].list
- Delete a CRM Directory Value v 3.0 crm.dictionary.[directory].delete