Get Contact, Company, and Lead Addresses v 3.0 crm.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:
crmWho can execute the method: a Bitrix24 administrator
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.address.list method returns the addresses of all contacts, companies, and leads in Bitrix24. The method is intended for exporting addresses: it does not check permissions for each owner, so only a Bitrix24 administrator can call it. CRM administrator permission is not enough for this method.
The addresses of one contact or company are returned by the crm.<type>.address.list method, and a lead address by crm.lead.address.get.
The method also returns addresses whose owners no longer exist in Bitrix24. Addresses of owners in the Recycle Bin are not returned.
The crm.address.list method at the /rest/api/ address is a new REST 3.0 method. The previous crm.address.list at the /rest/ address works as before and has different fields and filter.
Method Parameters
|
Name |
Description |
|
select |
List of address fields to return, for example, Default: |
|
filter |
Filter in the REST 3.0 format: an array of conditions in the form The syntax and operators are described in the REST 3.0 overview |
|
order |
Sorting in the format Possible direction values:
|
|
pagination |
Pagination object: |
Address Fields
|
Field |
Description |
|
id |
Address ID. When the address type changes, the address gets a new ID |
|
typeId |
Address type: |
|
ownerTypeId |
Owner type: |
|
ownerId |
Owner ID. It is unique only together with |
|
requisiteId |
ID of the requisite in which a contact or company address is stored. |
|
address1 |
Street, building, block, structure |
|
address2 |
Apartment or office |
|
city |
City |
|
postalCode |
Postal code |
|
region |
District |
|
province |
Region |
|
country |
Country |
|
countryCode |
Country code from the Bitrix24 locations reference |
Empty text fields are returned as an empty string. The field description is returned by the crm.address.field.list and crm.address.field.get methods.
How to Export All Addresses
For a full export, page through by ID rather than by page number: sort by {"id": "asc"} and pass the condition ["id", ">", <last retrieved id>] in each next request. With a large offset, the request runs slower.
An address whose type changes during the export gets a new id and may appear in the export twice or not at all.
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.address.list
The examples retrieve the next page of contact addresses after the address with id = 100.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["ownerTypeId","=",3],["id",">",100]],"select":["id","typeId","ownerTypeId","ownerId","requisiteId","address1","city"],"order":{"id":"asc"},"pagination":{"limit":50}}' \
https://**put_your_bitrix24_address**/rest/api/**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 '{"filter":[["ownerTypeId","=",3],["id",">",100]],"select":["id","typeId","ownerTypeId","ownerId","requisiteId","address1","city"],"order":{"id":"asc"},"pagination":{"limit":50},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.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 PortalAddressListResult = {
items: Array<{
id: number
typeId: number
ownerTypeId: number
ownerId: number
requisiteId: number
address1: string
city: string
}>
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<PortalAddressListResult>(
'crm.address.list',
{
filter: [
['ownerTypeId', '=', 3],
['id', '>', 100],
],
select: ['id', 'typeId', 'ownerTypeId', 'ownerId', 'requisiteId', 'address1', 'city'],
order: {
id: '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 listPortalAddresses() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.address.list',
{
filter: [
['ownerTypeId', '=', 3],
['id', '>', 100],
],
select: ['id', 'typeId', 'ownerTypeId', 'ownerId', 'requisiteId', 'address1', 'city'],
order: {
id: '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', listPortalAddresses)
</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.address.list"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"filter": [
["ownerTypeId", "=", 3],
["id", ">", 100],
],
"select": ["id", "typeId", "ownerTypeId", "ownerId", "requisiteId", "address1", "city"],
"order": {
"id": "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.address.list',
[
'filter' => [
['ownerTypeId', '=', 3],
['id', '>', 100],
],
'select' => ['id', 'typeId', 'ownerTypeId', 'ownerId', 'requisiteId', 'address1', 'city'],
'order' => [
'id' => '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.address.list',
{
filter: [
['ownerTypeId', '=', 3],
['id', '>', 100],
],
select: ['id', 'typeId', 'ownerTypeId', 'ownerId', 'requisiteId', 'address1', 'city'],
order: {
id: '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.address.list',
[
'filter' => [
['ownerTypeId', '=', 3],
['id', '>', 100],
],
'select' => ['id', 'typeId', 'ownerTypeId', 'ownerId', 'requisiteId', 'address1', 'city'],
'order' => [
'id' => '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.address.list", b24.Params{
"filter": []any{
[]any{"ownerTypeId", "=", 3},
[]any{"id", ">", 100},
},
"select": []string{"id", "typeId", "ownerTypeId", "ownerId", "requisiteId", "address1", "city"},
"order": b24.Params{
"id": "asc",
},
"pagination": b24.Params{
"limit": 50,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.address.list: %w", err)
}
var result struct {
Items []struct {
ID int `json:"id"`
TypeID int `json:"typeId"`
OwnerTypeID int `json:"ownerTypeId"`
OwnerID int `json:"ownerId"`
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.OwnerTypeID, item.OwnerID, item.City)
}
Response Handling
HTTP status: 200
{
"result": {
"items": [
{
"id": 101,
"typeId": 1,
"ownerTypeId": 3,
"ownerId": 113,
"requisiteId": 0,
"address1": "",
"city": ""
},
{
"id": 103,
"typeId": 1,
"ownerTypeId": 3,
"ownerId": 115,
"requisiteId": 0,
"address1": "",
"city": ""
}
]
},
"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 |
Description |
|
result |
Object with response data |
|
result.items |
Addresses with the fields from |
|
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": "Owner type 8 is not supported.",
"field": "filter.ownerTypeId"
}
]
}
}
|
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 |
|
|
DTO |
Filter only by |
|
|
DTO |
Sort only by |
Filter Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Owner type |
Pass |
Access Error
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 Bitrix24 administrator |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Check the field names in |
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 |