Получить список адресов по фильтру crm.address.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь
Метод возвращает список адресов по фильтру.
Адреса перемещены в реквизиты. В карточке CRM они имеют отображение в виде отдельного поля.
К объекту CRM могут быть привязаны несколько реквизитов. Внутри реквизита может быть несколько адресов (каждый своего типа).
Параметры метода
|
Название |
Описание |
|
select |
Массив со списком полей, которые необходимо выбрать (смотрите поля адресов). Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля адресов |
|
filter |
Объект для фильтрации выбранных адресов в формате Возможные значения для Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных адресов в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение Формула расчета значения параметра
|
Описание полей адреса
|
Название |
Описание |
|
TYPE_ID |
Идентификатор типа адреса. Элемент перечисления «Тип адреса». Элементы перечисления «Тип адреса» можно получить с помощью метода crm.enum.addresstype |
|
ENTITY_TYPE_ID |
Идентификатор типа родительского объекта. Идентификаторы типов объектов можно получить с помощью метода crm.enum.ownertype. Адреса могут быть привязаны только к Реквизитам (а реквизиты уже к компаниям либо контактам) или Лидам. Для обратной совместимости оставлена возможность связывать Адреса с Контактами или Компаниями. Но эта связь возможна только на некоторых старых порталах, где специально техподдержкой был включен старый режим работы с адресами |
|
ENTITY_ID |
Идентификатор родительского объекта |
|
ADDRESS_1 |
Улица, дом, корпус, строение |
|
ADDRESS_2 |
Квартира / офис |
|
CITY |
Город |
|
POSTAL_CODE |
Почтовый индекс |
|
REGION |
Район |
|
PROVINCE |
Область |
|
COUNTRY |
Страна |
|
COUNTRY_CODE |
Код страны. Не используется, оставлено для обратной совместимости. В качестве значения можно указать пустую строку |
|
LOC_ADDR_ID |
Идентификатор адреса местоположения. Это поле содержит идентификатор объекта адреса в модуле Если при создании адреса указан идентификатор адреса модуля Если же было указано хоть одно строковое поле, то в адресе CRM будут сохранены только указанные поля, и их значения перезапишут соответствующие значения в объекте location-адреса. Такое же поведение будет и при обновлении адреса |
|
ANCHOR_TYPE_ID |
Идентификатор типа основного родительского объекта. Это поле для служебного использования. Значение заполняется автоматически при добавлении адреса. Идентификаторы типов объектов можно получить с помощью метода crm.enum.ownertype. В этом поле содержится идентификатор типа родительского объекта реквизита (компания или контакт), если адрес привязан к реквизиту. Если адрес привязан к лиду, то этим значением будет идентификатор типа лид |
|
ANCHOR_ID |
Это поле для служебного использования. Значение заполняется автоматически при добавлении адреса. В этом поле содержится идентификатор родительского объекта реквизита (компании или контакта), если адрес привязан к реквизиту. Если адрес привязан к лиду, то этим значением будет идентификатор лида |
Примеры кода
Как использовать примеры в документации
Поиск адресов по привязке к типу Реквизит:
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"TYPE_ID":"asc"},"filter":{"ENTITY_TYPE_ID":8,"ENTITY_ID":7335},"limit":10}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.address.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"TYPE_ID":"asc"},"filter":{"ENTITY_TYPE_ID":8,"ENTITY_ID":7335},"limit":10,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.address.list
// 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 each AddressItem returned in result[]
type AddressItem = {
TYPE_ID: string
ENTITY_TYPE_ID: string
ENTITY_ID: string
ADDRESS_1: string
ADDRESS_2: string
CITY: string
POSTAL_CODE: string
REGION: string
PROVINCE: string
COUNTRY: string
COUNTRY_CODE: string | null
LOC_ADDR_ID: string
ANCHOR_TYPE_ID: string
ANCHOR_ID: string
}
try {
// crm.address.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<AddressItem[]>({
method: 'crm.address.list',
params: {
order: { TYPE_ID: 'asc' },
filter: { ENTITY_TYPE_ID: 8, ENTITY_ID: 7335 },
start: 0,
},
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('Addresses found:', result.length, result)
}
} 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 fetchAddressList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.address.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'crm.address.list',
params: {
order: { TYPE_ID: 'asc' },
filter: { ENTITY_TYPE_ID: 8, ENTITY_ID: 7335 },
start: 0,
},
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('Addresses found:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchAddressList)
</script>
try {
$response = $b24Service
->core
->call(
'crm.address.list',
[
'order' => ['TYPE_ID' => 'asc'],
'filter' => ['ENTITY_TYPE_ID' => 8, 'ENTITY_ID' => 7335],
'limit' => 10,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
if ($result->more()) {
$result->next();
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching address list: ' . $e->getMessage();
}
BX24.callMethod(
"crm.address.list",
{
order: { "TYPE_ID": "asc"},
filter: { "ENTITY_TYPE_ID": 8, "ENTITY_ID": 7335},
limit: 10
},
function(result)
{
if(result.error())
console.error(result.error());
else
{
console.dir(result.data());
if(result.more())
result.next();
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.address.list',
[
'order' => ['TYPE_ID' => 'asc'],
'filter' => ['ENTITY_TYPE_ID' => 8, 'ENTITY_ID' => 7335],
'limit' => 10
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Пример
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.address.list(
select=["TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID", "ADDRESS_1", "ADDRESS_2", "CITY", "POSTAL_CODE", "COUNTRY"],
filter={"ENTITY_TYPE_ID": 8, "ENTITY_ID": 7335},
order={"TYPE_ID": "ASC"},
start=0,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
Пример as_list
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.address.list(
select=["TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID", "ADDRESS_1", "CITY", "COUNTRY"],
filter={"ENTITY_TYPE_ID": 8, "ENTITY_ID": 7335},
order={"TYPE_ID": "ASC"},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"TYPE_ID": "1",
"ENTITY_TYPE_ID": "8",
"ENTITY_ID": "7335",
"ADDRESS_1": "Ленина 2",
"ADDRESS_2": "701",
"CITY": "Тюмень",
"POSTAL_CODE": "625003",
"REGION": "Тюменская обл",
"PROVINCE": "Тюменская обл",
"COUNTRY": "Россия",
"COUNTRY_CODE": null,
"LOC_ADDR_ID": "479",
"ANCHOR_TYPE_ID": "3",
"ANCHOR_ID": "17192"
}
],
"total": 1,
"time": {
"start": 1716301758.664873,
"finish": 1716301759.73158,
"duration": 1.0667071342468262,
"processing": 0.028820037841796875,
"date_start": "2024-05-21T16:29:18+02:00",
"date_finish": "2024-05-21T16:29:19+02:00",
"operating": 0
}
}
Если у контакта 2 разных реквизита, к которым привязаны адреса:
HTTP-статус: 200
{
"result": [
{
"TYPE_ID": "1",
"ENTITY_TYPE_ID": "8",
"ENTITY_ID": "7335",
"ADDRESS_1": "Ленина 2",
"ADDRESS_2": "701",
"CITY": "Тюмень",
"POSTAL_CODE": "625003",
"REGION": "Тюменская обл",
"PROVINCE": "Тюменская обл",
"COUNTRY": "Россия",
"COUNTRY_CODE": null,
"LOC_ADDR_ID": "479",
"ANCHOR_TYPE_ID": "3",
"ANCHOR_ID": "17192"
},
{
"TYPE_ID": "1",
"ENTITY_TYPE_ID": "8",
"ENTITY_ID": "7335",
"ADDRESS_1": "Ленина",
"ADDRESS_2": "2",
"CITY": "Тюмень",
"POSTAL_CODE": "666000",
"REGION": "Тюменская область рег",
"PROVINCE": "Тюменская область",
"COUNTRY": "Россия",
"COUNTRY_CODE": null,
"LOC_ADDR_ID": "129",
"ANCHOR_TYPE_ID": "3",
"ANCHOR_ID": "17192"
}
],
"total": 2,
"time": {
"start": 1716301758.664873,
"finish": 1716301759.73158,
"duration": 1.0667071342468262,
"processing": 0.028820037841796875,
"date_start": "2024-05-21T16:29:18+02:00",
"date_finish": "2024-05-21T16:29:19+02:00",
"operating": 0
}
}
Дополнительная информация о результате
Поле ANCHOR_TYPE_ID заполнено значением из crm.enum.ownertype (в примере это Контакты), а поле ANCHOR_ID содержит ID объекта (в данном случае Контакта).
Поля ANCHOR_TYPE_ID и ANCHOR_ID в двух вышеуказанных примерах одинаковы, следовательно, оба адреса относятся к одному Контакту.
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив объектов с информацией о выбранных адресах. Каждый элемент содержит выбранные поля адресов |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 40x, 50x
{
"error":0,
"error_description":"error"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав доступа для получения списка адресов. Нет доступа на чтение компаний, контактов, лидов |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |