Get Contact or Company Addresses v 3.0 crm.[type].address.list

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

Who can execute the method: a user with permission to view the contact or company whose addresses are requested

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.<type>.address.list method returns the addresses of one contact or company from all its requisites. The owner type is set by the <type> segment of the method name, and the owner is set by a filter condition.

The addresses of all contacts, companies, and leads in Bitrix24 are returned by the crm.address.list method.

Method Name for the Object Type

Object type

Method

Contact

crm.contact.address.list

Company

crm.company.address.list

A lead address is returned by the crm.lead.address.get method.

The method name is written in lowercase: crm.company.address.list, not crm.Company.address.list. If the name is written in a different case, the method returns the "Method Not Found" error.

Method Parameters

Required parameters are marked with *

Name
type

Description

filter*
array

Filter in the REST 3.0 format: an array of conditions in the form ["field", "operator", "value"]. The owner condition is required, for example, [["contactId","=",3219]]. Parameter description

order
object

Sorting in the format {"field": "direction"}. You can sort by the id and typeId fields.

Possible direction values:

  • asc — ascending
  • desc — descending

pagination
object

Pagination object: limit is the number of addresses per page, 50 by default, page is the page number, and offset is the number of addresses to skip. A zero or negative limit and a negative offset cause an error

The method returns all address fields. The select parameter does not affect the response.

The filter Parameter

The method accepts only the conditions from the table and combines them with AND:

Field

Operators

Description

contactId

=

Contact ID. A required condition in crm.contact.address.list

companyId

=

Company ID. A required condition in crm.company.address.list

typeId

=

Address type, for example, 6 — legal address. The values are listed in the address methods overview

The method does not accept condition groups with logic, the in operator, other operators, or other fields.

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.contact.address.list

The examples retrieve all addresses of a contact. For a company, replace the method name according to the table above and the contactId condition with companyId.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":[["contactId","=",3219]],"order":{"typeId":"asc"},"pagination":{"limit":50}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.address.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":[["contactId","=",3219]],"order":{"typeId":"asc"},"pagination":{"limit":50},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.contact.address.list
        

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 AddressListResult = {
          items: Array<{
            id: number
            typeId: number
            contactId: number
            requisiteId: number
            address1: string
            city: string
            postalCode: string
            country: string
          }>
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<AddressListResult>(
            'crm.contact.address.list',
            {
              filter: [
                ['contactId', '=', 3219],
              ],
              order: {
                typeId: 'asc',
              },
              pagination: {
                limit: 50,
              },
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Addresses:', result.items)
          }
        } 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 listAddresses() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.contact.address.list',
                {
                  filter: [
                    ['contactId', '=', 3219],
                  ],
                  order: {
                    typeId: 'asc',
                  },
                  pagination: {
                    limit: 50,
                  },
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Addresses:', result.items)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listAddresses)
        </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.contact.address.list"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "filter": [
                        ["contactId", "=", 3219],
                    ],
                    "order": {
                        "typeId": "asc",
                    },
                    "pagination": {
                        "limit": 50,
                    },
                },
                prefer_version=3,
            )
            result = response["result"]
            print(result)
        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.contact.address.list',
                    [
                        'filter' => [
                            ['contactId', '=', 3219],
                        ],
                        'order' => [
                            'typeId' => 'asc',
                        ],
                        'pagination' => [
                            'limit' => 50,
                        ],
                    ]
                );
        
            $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.contact.address.list',
            {
                filter: [
                    ['contactId', '=', 3219],
                ],
                order: {
                    typeId: 'asc',
                },
                pagination: {
                    limit: 50,
                },
            },
            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.contact.address.list',
            [
                'filter' => [
                    ['contactId', '=', 3219],
                ],
                'order' => [
                    'typeId' => 'asc',
                ],
                'pagination' => [
                    'limit' => 50,
                ],
            ]
        );
        
        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.contact.address.list", b24.Params{
        	"filter": []any{
        		[]any{"contactId", "=", 3219},
        	},
        	"order": b24.Params{
        		"typeId": "asc",
        	},
        	"pagination": b24.Params{
        		"limit": 50,
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.contact.address.list: %w", err)
        }
        
        var result struct {
        	Items []struct {
        		ID          int    `json:"id"`
        		TypeID      int    `json:"typeId"`
        		ContactID   int    `json:"contactId"`
        		RequisiteID int    `json:"requisiteId"`
        		Address1    string `json:"address1"`
        		City        string `json:"city"`
        	} `json:"items"`
        }
        if err := json.Unmarshal(res.Result, &result); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, item := range result.Items {
        	fmt.Println(item.ID, item.TypeID, item.City, item.Address1)
        }
        

Response Handling

HTTP status: 200

{
            "result": {
                "items": [
                    {
                        "id": 633,
                        "typeId": 1,
                        "contactId": 3219,
                        "requisiteId": 547,
                        "address1": "Friedrichstraße 1",
                        "address2": "Office 10",
                        "city": "Berlin",
                        "postalCode": "10117",
                        "region": "",
                        "province": "",
                        "country": "Germany",
                        "countryCode": ""
                    },
                    {
                        "id": 637,
                        "typeId": 6,
                        "contactId": 3219,
                        "requisiteId": 547,
                        "address1": "Hauptstraße 5",
                        "address2": "",
                        "city": "Munich",
                        "postalCode": "",
                        "region": "",
                        "province": "",
                        "country": "",
                        "countryCode": ""
                    }
                ]
            },
            "time": {
                "start": 1793709949,
                "finish": 1793709949.853585,
                "duration": 0.8535850048065186,
                "processing": 0,
                "date_start": "2026-11-03T15:45:49+03:00",
                "date_finish": "2026-11-03T15:45:49+03:00",
                "operating_reset_at": 1793710260,
                "operating": 0.3442521095275879
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with response data

result.items
object[]

Owner addresses with all fields. Company addresses contain companyId instead of contactId. If there are no addresses, the array is empty. Description of address fields

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION",
                "message": "Error validating request object filters.",
                "validation": [
                    {
                        "message": "Filter for required field \"contactId\" is required.",
                        "field": "filter.contactId"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

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

filter

Required field filter is missing

Pass filter with an owner condition

city

DTO OwnerAddressContactDto in field city requires attribute Filterable to perform this request

Filter only by the owner and typeId

city

DTO OwnerAddressContactDto in field city requires attribute Sortable to perform this request

Sort only by id and typeId

Filter Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION

Field

Error description

How to Fix

filter.contactId

Filter for required field contactId is required

Add an owner condition to filter. For a company, the field is companyId

Invalid Filter

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Field

Error description

How to Fix

-

Invalid filter #FILTER#

Use only the = operator and the conditions from the filter parameter table

Invalid Pagination

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Field

Error description

How to Fix

-

Incorrect pagination parameter value: #PAGE#

Pass limit greater than zero and offset not less than zero

Owner Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field

Error description

How to Fix

-

Entity with ID #ID# was not found

The contact or company from the filter does not exist, or you do not have permission to view it. Check the ID and the method name

Method Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404

Field

Error description

How to Fix

-

Method #METHOD# was not found

Check the method name: it is written in lowercase, for example, crm.company.address.list. The method exists only for contacts and companies

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

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

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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