Get Address Types crm.enum.addresstype
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
crmWho can execute the method: any user
The method crm.enum.addresstype returns a list of address types. Use the ID of the address type as the value for the TYPE_ID parameter in the methods crm.address.*.
Method Parameters
No parameters.
Code Examples
How to Use Examples in Documentation
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.enum.addresstype
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.enum.addresstype
try
{
const response = await $b24.callMethod(
"crm.enum.addresstype",
{}
);
const result = response.getData().result;
if (result.error())
{
console.error(result.error());
}
else
{
console.dir(result);
}
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'crm.enum.addresstype',
[]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error calling crm.enum.addresstype: ' . $e->getMessage();
}
BX24.callMethod(
"crm.enum.addresstype",
{},
function(result) {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.enum.addresstype',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": [
{
"ID": 11,
"NAME": "Delivery Address",
"SYMBOL_CODE": null,
"SYMBOL_CODE_SHORT": null
},
{
"ID": 1,
"NAME": "Actual Address",
"SYMBOL_CODE": null,
"SYMBOL_CODE_SHORT": null
},
{
"ID": 6,
"NAME": "Legal Address",
"SYMBOL_CODE": null,
"SYMBOL_CODE_SHORT": null
},
{
"ID": 4,
"NAME": "Registration Address",
"SYMBOL_CODE": null,
"SYMBOL_CODE_SHORT": null
},
{
"ID": 8,
"NAME": "Correspondence Address",
"SYMBOL_CODE": null,
"SYMBOL_CODE_SHORT": null
},
{
"ID": 9,
"NAME": "Beneficiary Address",
"SYMBOL_CODE": null,
"SYMBOL_CODE_SHORT": null
}
],
"time": {
"start": 1750152255.931318,
"finish": 1750152255.967967,
"duration": 0.03664898872375488,
"processing": 0.0003609657287597656,
"date_start": "2025-06-17T12:24:15+02:00",
"date_finish": "2025-06-17T12:24:15+02:00",
"operating_reset_at": 1750152855,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Array of address types (detailed description) |
|
time |
Information about the request execution time |
Fields of the result array
|
Name |
Description |
|
ID |
Identifier of the address type |
|
NAME |
Name of the address type |
|
SYMBOL_CODE |
Symbolic code |
|
SYMBOL_CODE_SHORT |
Short symbolic code |
Error Handling
The method does not return errors.
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 permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |