Get a List of Addresses by Filter crm.address.list

Scope: crm

Who can execute the method: any user

The method returns a list of addresses based on the filter.

Addresses are moved to the details. In the CRM card, they are displayed as a separate field.

Multiple details can be linked to a CRM object. Within a detail, there can be several addresses (each of a different type).

Method Parameters

Name `type`	Description
select `array`	An array of fields to select (see address fields). If the array is not provided or an empty array is passed, all available address fields will be selected.
filter `object`	An object for filtering selected addresses in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Possible values for `field` correspond to address fields. An additional prefix can be assigned to the key to clarify the filter's behavior. Possible prefix values: `>=` — greater than or equal to `>` — greater than `<=` — less than or equal to `<` — less than `@` — IN, an array is passed as the value `!@` — NOT IN, an array is passed as the value `%` — LIKE, substring search. The `%` symbol should not be included in the filter value. The search looks for the substring in any position of the string. `=%` — LIKE, substring search. The `%` symbol must be included in the value. Examples: `"mol%"` — searches for values starting with "mol" `"%mol"` — searches for values ending with "mol" `"%mol%"` — searches for values where "mol" can be in any position `%=` — LIKE (similar to `=%`) `!%` — NOT LIKE, substring search. The `%` symbol should not be included in the filter value. The search goes from both sides. `!=%` — NOT LIKE, substring search. The `%` symbol must be included in the value. Examples: `"mol%"` — searches for values not starting with "mol" `"%mol"` — searches for values not ending with "mol" `"%mol%"` — searches for values where the substring "mol" is not present in any position `!%=` — NOT LIKE (similar to `!=%`) `=` — equals, exact match (used by default) `!=` — not equal `!` — not equal
order `object`	An object for sorting selected addresses in the format `{"field_1": "order_1", ... "field_N": "order_N"}`. Possible values for `field` correspond to address fields. Possible values for `order`: `asc` — in ascending order `desc` — in descending order
start `integer`	This parameter is used to manage pagination. The page size of results is always static: 50 records. To select the second page of results, you need to pass the value `50`. To select the third page of results, the value is `100`, and so on. The formula for calculating the `start` parameter value: `start = (N-1) * 50`, where `N` is the desired page number

Description of Address Fields

Name `type`	Description
TYPE_ID `integer`	Identifier of the address type. Enumeration element "Address Type". Enumeration elements for "Address Type" can be obtained using the method crm.enum.addresstype
ENTITY_TYPE_ID `integer`	Identifier of the parent object's type. Object type identifiers can be obtained using the method crm.enum.ownertype. Addresses can only be linked to Details (and details to companies or contacts) or Leads. For backward compatibility, the ability to link Addresses to Contacts or Companies is retained. However, this link is only possible on some older accounts where the old address handling mode was 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, linked to 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 fields of the address in this case, they will be filled from the location address. If at least one string field was 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's 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's type of the detail (company or contact) if the address is linked to the detail. 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 detail (company or contact) if the address is linked to the detail. If the address is linked to a lead, this value will be the lead identifier.

Code Examples

How to Use Examples in Documentation

Searching for addresses linked to the Detail type:

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'crm.address.list',
            {
              order: { "TYPE_ID": "asc"},
              filter: { "ENTITY_TYPE_ID": 8, "ENTITY_ID": 7335},
              limit: 10
            },
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('crm.address.list', { order: { "TYPE_ID": "asc"}, filter: { "ENTITY_TYPE_ID": 8, "ENTITY_ID": 7335}, limit: 10 }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.address.list', { order: { "TYPE_ID": "asc"}, filter: { "ENTITY_TYPE_ID": 8, "ENTITY_ID": 7335}, limit: 10 }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }

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>';

Response Handling

HTTP Status: 200

{
            "result": [
                {
                    "TYPE_ID": "1",
                    "ENTITY_TYPE_ID": "8",
                    "ENTITY_ID": "7335",
                    "ADDRESS_1": "Address 1",
                    "ADDRESS_2": "701",
                    "CITY": "Los Angeles",
                    "POSTAL_CODE": "625003",
                    "REGION": "California",
                    "PROVINCE": "California",
                    "COUNTRY": "USA",
                    "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
            }
        }

If a contact has 2 different details to which addresses are linked:

HTTP Status: 200

{
            "result": [
                {
                    "TYPE_ID": "1",
                    "ENTITY_TYPE_ID": "8",
                    "ENTITY_ID": "7335",
                    "ADDRESS_1": "Address 2",
                    "ADDRESS_2": "701",
                    "CITY": "Los Angeles",
                    "POSTAL_CODE": "625003",
                    "REGION": "California",
                    "PROVINCE": "California",
                    "COUNTRY": "USA",
                    "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",
                    "ADDRESS_2": "2",
                    "CITY": "Los Angeles",
                    "POSTAL_CODE": "666000",
                    "REGION": "California",
                    "PROVINCE": "California",
                    "COUNTRY": "USA",
                    "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
            }
        }

Additional Information about the Result

The ANCHOR_TYPE_ID field is filled with a value from crm.enum.ownertype (in this example, it is Contacts), and the ANCHOR_ID field contains the ID of the object (in this case, the Contact).

The ANCHOR_TYPE_ID and ANCHOR_ID fields in the two examples above are the same, indicating that both addresses belong to the same Contact.

Returned Data

Name `type`	Description
result `array`	An array of objects with information about the selected addresses. Each element contains the selected address fields
total `integer`	The total number of records found
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 40x, 50x

{
            "error":0,
            "error_description":"error"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description
`Access denied`	Insufficient access rights to retrieve the list of addresses. No read access to companies, contacts, leads

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Update address of detail

Delete address

Get a List of Addresses by Filter crm.address.list

Method ParametersMethod Parameters

Description of Address FieldsDescription of Address Fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning