[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-entities\u002Fcrm-enums\u002Faddress-types":3,"docs-tabs-entities\u002Fcrm-enums\u002Faddress-types":6},{"content":4,"lastmod":5},"## CRM address types\n\n`GET \u002Fv1\u002Fcrm-enums\u002Faddress-types`\n\nReference list of address types on the Bitrix24 account: actual, legal, delivery address and others. Use it to pick a type before writing an address.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fcrm-enums\u002Faddress-types\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fcrm-enums\u002Faddress-types\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fcrm-enums\u002Faddress-types', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { data } = await res.json()\nfor (const type of data) console.log(type.id, type.name)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fcrm-enums\u002Faddress-types', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { data } = await res.json()\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on a successful request |\n| `data` | array | The Bitrix24 account's address types |\n| `data[].id` | number | Type ID. Pass it as `typeId` to the [address methods](\u002Fdocs\u002Fentities\u002Faddresses) |\n| `data[].name` | string | Type name in the Bitrix24 account language |\n| `data[].symbolCode` | string \\| null | Symbolic type code. On the test Bitrix24 account it is `null` for every type |\n| `data[].symbolCodeShort` | string \\| null | Short symbolic code. On the test Bitrix24 account it is `null` for every type |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    { \"id\": 11, \"name\": \"Delivery address\", \"symbolCode\": null, \"symbolCodeShort\": null },\n    { \"id\": 1, \"name\": \"Actual address\", \"symbolCode\": null, \"symbolCodeShort\": null },\n    { \"id\": 6, \"name\": \"Legal address\", \"symbolCode\": null, \"symbolCodeShort\": null },\n    { \"id\": 4, \"name\": \"Registration address\", \"symbolCode\": null, \"symbolCodeShort\": null },\n    { \"id\": 8, \"name\": \"Mailing address\", \"symbolCode\": null, \"symbolCodeShort\": null },\n    { \"id\": 9, \"name\": \"Beneficiary address\", \"symbolCode\": null, \"symbolCodeShort\": null }\n  ]\n}\n```\n\n## Error response example\n\n401 — the `X-Api-Key` header is missing:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"MISSING_API_KEY\",\n    \"message\": \"API key required. Pass via X-Api-Key header.\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 403 | `BITRIX_ACCESS_DENIED` | The key's user has no permission to read the reference list in Bitrix24 |\n| 422 | `BITRIX_ERROR` | Bitrix24 rejected the request; the reason is in `message` |\n| 429 | `RATE_LIMITED` | Bitrix24 request rate exceeded; retry in 1-2 seconds |\n| 502 | `BITRIX_RESPONSE_INVALID` | Bitrix24 returned the reference list in an unexpected shape |\n| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable: it returned a server error or the connection dropped |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |\n| 401 | `TOKEN_MISSING` | The API key has no Bitrix24 tokens configured |\n| 403 | `SCOPE_DENIED` | The API key lacks the `crm` scope |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n- **The Bitrix24 account defines the set and order of types.** The list is not sorted by `id`. Match types by `id`, not by name or position in the array.\n- **Query parameters are ignored.** The method takes no parameters; any passed in the URL do not affect the response.\n\n## See also\n\n- [Addresses](\u002Fdocs\u002Fentities\u002Faddresses)\n- [CRM entity types](\u002Fdocs\u002Fentities\u002Fcrm-enums\u002Fowner-types)\n- [CRM reference lists](\u002Fdocs\u002Fentities\u002Fcrm-enums)\n","2026-10-15",{},1794739351619]