## List addresses

`GET /v1/addresses`

Returns a list of CRM entity addresses with support for filtering, sorting and auto-pagination. An address has no separate numeric `id`: to get a single address, use the three values — `typeId`, `entityTypeId` and `entityId`.

## Parameters

| Parameter | Type | Default | Description |
|----------|-----|-----------|---------|
| `limit` | number | `50` | Number of records (up to 5000). When `limit > 50`, Vibecode automatically requests several pages from Bitrix24 |
| `offset` | number | `0` | Skip N records. When `offset ≥ 2500`, `limit ≤ 500` is recommended |
| `sort` / `order` | string / object | — | Sorting: `?sort=typeId` or `?order[typeId]=desc` |
| `filter` | object | — | Filtering by the fields of `GET /v1/addresses/fields`.<br>[Filtering syntax](/docs/filtering). Example: `?filter[entityTypeId]=8&filter[entityId]=42` |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/addresses?filter[entityTypeId]=8&filter[entityId]=42" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth app

```bash
curl "https://vibecode.bitrix24.com/v1/addresses?filter[entityTypeId]=8&filter[entityId]=42" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.com/v1/addresses?filter[entityTypeId]=8&filter[entityId]=42',
  {
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
    },
  }
)

const { success, data, meta } = await res.json()
console.log(`Found ${meta.total} addresses`)
```

### JavaScript — OAuth app

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.com/v1/addresses?filter[entityTypeId]=8&filter[entityId]=42',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)

const { success, data, meta } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | Array of addresses (all fields — see [Address fields](/docs/entities/addresses/fields)) |
| `meta.total` | number | Total number of records matching the filter |
| `meta.hasMore` | boolean | Whether there are more records beyond `limit` |

## Response example

```json
{
  "success": true,
  "data": [
    {
      "typeId": 1,
      "entityTypeId": 3,
      "entityId": 9,
      "address1": null,
      "address2": null,
      "city": null,
      "postalCode": null,
      "region": null,
      "province": null,
      "country": null,
      "countryCode": null,
      "locAddrId": 0,
      "anchorTypeId": 3,
      "anchorId": 9
    },
    {
      "typeId": 1,
      "entityTypeId": 3,
      "entityId": 17,
      "address1": null,
      "address2": null,
      "city": null,
      "postalCode": null,
      "region": null,
      "province": null,
      "country": null,
      "countryCode": null,
      "locAddrId": 0,
      "anchorTypeId": 3,
      "anchorId": 17
    }
  ],
  "meta": {
    "total": 185,
    "hasMore": true
  }
}
```

## Error response example

403 — no scope:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | The API key lacks the `crm` scope |
| 401 | `TOKEN_MISSING` | The API key has no configured tokens |
| 400 | `INVALID_FILTER` | Error in the filter syntax |

Full list of common API errors — [Errors](/docs/errors).

## Known specifics

**An address has no separate numeric `id`.** Each address is identified by three values: `typeId` (address type), `entityTypeId` (owner type) and `entityId` (owner ID). To get a single address, use `GET /v1/addresses/:typeId/:entityTypeId/:entityId`.

**Auto-pagination.** When `limit > 50`, Vibecode automatically requests several pages from Bitrix24 and returns all records in a single response.

## See also

- [Get address](/docs/entities/addresses/get)
- [Search addresses](/docs/entities/addresses/search)
- [Address fields](/docs/entities/addresses/fields)
- [Filtering syntax](/docs/filtering)
- [Entity API](/docs/entity-api)
- [Batch](/docs/batch)
- [Limits and optimization](/docs/optimization)