Get Description of Address Fields crm.address.fields

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: crm

Who can execute the method: any user

The method returns a formal description of the address fields.

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.address.fields
        
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.address.fields
        
// 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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type AddressFieldsResult = Record<string, FieldDescriptor>
        
        type FieldDescriptor = {
          type: string
          isRequired: boolean
          isReadOnly: boolean
          isImmutable: boolean
          isMultiple: boolean
          isDynamic: boolean
          title: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<AddressFieldsResult>({
            method: 'crm.address.fields',
            params: {},
            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('Address field names:', Object.keys(result))
            console.info('TYPE_ID field:', result['TYPE_ID'])
          }
        } 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 getAddressFields() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.address.fields',
                params: {},
                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('Address field names:', Object.keys(result))
              console.info('TYPE_ID field:', result['TYPE_ID'])
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getAddressFields)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.address.fields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching CRM address fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.address.fields",
            {},
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.address.fields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Example

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.address.fields().response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

Response Handling

HTTP Status: 200

{
            "result": {
                "TYPE_ID": {
                    "type": "integer",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": true,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "TYPE_ID"
                },
                "ENTITY_TYPE_ID": {
                    "type": "integer",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": true,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "ENTITY_TYPE_ID"
                },
                "ENTITY_ID": {
                    "type": "integer",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": true,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "ENTITY_ID"
                },
                "ADDRESS_1": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Street, house, building, structure"
                },
                "ADDRESS_2": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Apartment / office"
                },
                "CITY": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "City"
                },
                "POSTAL_CODE": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Postal code"
                },
                "REGION": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Region"
                },
                "PROVINCE": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Province"
                },
                "COUNTRY": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Country"
                },
                "COUNTRY_CODE": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "COUNTRY_CODE"
                },
                "LOC_ADDR_ID": {
                    "type": "integer",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Location address identifier"
                },
                "ANCHOR_TYPE_ID": {
                    "type": "integer",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "ANCHOR_TYPE_ID"
                },
                "ANCHOR_ID": {
                    "type": "integer",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "ANCHOR_ID"
                }
            },
            "time": {
                "start": 1712938174.436428,
                "finish": 1712938175.432068,
                "duration": 0.9956400394439697,
                "processing": 0.5710320472717285,
                "date_start": "2024-04-12T19:09:34+02:00",
                "date_finish": "2024-04-12T19:09:35+02:00"
            }
        }

Returned Data

Name
type

Description

result
object

An object in the format {"field_1": "value_1", ... "field_N": "value_N"}, where field is the field identifier and value is the object with field attributes

time
time

Information about the request execution time

Description of Address Fields

Name
type

Description

TYPE_ID
integer

Identifier of the address type. Enumeration element "Address Type".

Enumeration elements "Address Type" can be obtained using the method crm.enum.addresstype

ENTITY_TYPE_ID
integer

Identifier of the parent object type.

Object type identifiers can be obtained using the method crm.enum.ownertype.

Addresses can only be linked to Requisites (and requisites to companies or contacts) or Leads.

For backward compatibility, the ability to link Addresses to Contacts or Companies has been retained. However, this link is only possible on some old accounts where the old address handling mode has been specifically enabled by support.

ENTITY_ID
string

Identifier of the parent object

ADDRESS_1
string

Street, house, building, structure

ADDRESS_2
string

Apartment / office

CITY
string

City

POSTAL_CODE
string

Postal code

REGION
string

Region

PROVINCE
string

Province

COUNTRY
string

Country

COUNTRY_CODE
string

Country code.

Not used, retained for backward compatibility. An empty string can be specified as a value.

LOC_ADDR_ID
integer

Identifier of the location address.

This field contains the identifier of the address object in the Location module, associated with the CRM address object. Each CRM address corresponds to an address object in the location module. This can be used to copy an existing address into CRM with location information that is not present in the CRM address fields.

If the identifier of the location module address is specified when creating an address, a copy of the location address is created and linked to the created CRM address. If no values are specified for the string address fields in this case, they will be filled from the location address.

If at least one string field is specified, only the specified fields will be saved in the CRM address, and their values will overwrite the corresponding values in the location address object. The same behavior will occur when updating the address.

ANCHOR_TYPE_ID
integer

Identifier of the main parent object type.

This field is for internal use. The value is automatically filled when adding an address.

Object type identifiers can be obtained using the method crm.enum.ownertype.

This field contains the identifier of the parent object type of the requisite (company or contact) if the address is linked to a requisite. If the address is linked to a lead, this value will be the lead type identifier.

ANCHOR_ID
integer

This field is for internal use. The value is automatically filled when adding an address.

This field contains the identifier of the parent object of the requisite (company or contact) if the address is linked to a requisite. If the address is linked to a lead, this value will be the lead identifier.

Description of Attributes

Name
type

Description

type
string

Field type

isRequired
boolean

"Required" attribute. Possible values:

  • true — yes
  • false — no

isReadOnly
boolean

"Read-only" attribute. Possible values:

  • true — yes
  • false — no

isImmutable
boolean

"Immutable" attribute. Possible values:

  • true — yes
  • false — no

isMultiple
boolean

"Multiple" attribute. Possible values:

  • true — yes
  • false — no

isDynamic
boolean

"Custom" attribute. Possible values:

  • true — yes
  • false — no

title
string

Field identifier

Error Handling

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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

Continue Learning

Previous
Delete address
Next
Overview of methods