Для AI-агентов: markdown этой страницы — /docs-content/entities/addresses/fields.md индекс документации — /llms.txt

Поля адреса

GET /v1/addresses/fields

Возвращает схему полей адреса — список всех допустимых полей с типами, признаками обязательности и доступности для записи.

Примеры

curl — личный ключ

Terminal

curl "https://vibecode.bitrix24.tech/v1/addresses/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal

curl "https://vibecode.bitrix24.tech/v1/addresses/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/addresses/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
const fieldNames = Object.keys(data.fields)

JavaScript — OAuth-приложение

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/addresses/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле	Битрикс24	Тип	RO	Описание
`typeId`	`TYPE_ID`	number	—	Тип адреса. Обязательный, неизменяемый после создания
`entityTypeId`	`ENTITY_TYPE_ID`	number	—	Тип владельца адреса. Обязательный, неизменяемый после создания
`entityId`	`ENTITY_ID`	number	—	ID владельца адреса. Обязательный, неизменяемый после создания
`address1`	`ADDRESS_1`	string	—	Улица, дом, корпус, строение
`address2`	`ADDRESS_2`	string	—	Квартира, офис
`city`	`CITY`	string	—	Город
`postalCode`	`POSTAL_CODE`	string	—	Почтовый индекс
`region`	`REGION`	string	—	Район
`province`	`PROVINCE`	string	—	Область
`country`	`COUNTRY`	string	—	Страна
`countryCode`	`COUNTRY_CODE`	string	—	Код страны
`locAddrId`	`LOC_ADDR_ID`	number	—	Идентификатор адреса местоположения
`anchorTypeId`	`ANCHOR_TYPE_ID`	number	да	Тип сущности, к которой привязан адрес
`anchorId`	`ANCHOR_ID`	number	да	ID сущности, к которой привязан адрес

RO — поле доступно только для чтения. Колонка «Битрикс24» — имя того же поля в Битрикс24.

Каждое поле в data.fields описано объектом. Кроме признаков type, isRequired, isReadOnly, isImmutable, isMultiple и isDynamic там приходят три текстовых ключа:

Ключ	Описание
`title`	Короткая подпись поля. Большинство подписей приходит из Битрикс24, они на языке портала. Там, где Битрикс24 вместо подписи отдаёт имя поля, например `TYPE_ID` или `COUNTRY_CODE`, подпись подставляет Вайбкод, и она приходит на русском языке
`label`	Та же подпись, что в `title`. Приходит рядом с ним, потому что у остальных сущностей подпись лежит именно в `label` — так подписи можно читать одним способом на любой сущности
`description`	Расширенное описание на русском языке: назначение поля, расшифровка кодов, поведение при записи. Приходит у тех полей, у которых есть что добавить к подписи

Пример ответа

JSON

{
  "success": true,
  "data": {
    "fields": {
      "typeId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Тип адреса",
        "label": "Тип адреса",
        "description": "Код типа адреса. Битрикс24 определяет двенадцать, с 1 по 12: 1 — фактический (в англоязычном интерфейсе Битрикс24 — Street address), 2 — второй, 3 — третий, 4 — адрес регистрации, 5 — рабочий, 6 — юридический, 7 — дополнительный, 8 — для корреспонденции, 9 — бенефициара, 10 — адрес банка, 11 — доставки, 12 — платёжный. Какие из них доступны порталу, зависит от его страновой зоны, поэтому часть кодов конкретный портал может не вернуть никогда. Входит в составной ключ адреса и неизменяем после создания."
      },
      "entityTypeId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Тип владельца",
        "label": "Тип владельца",
        "description": "Код типа сущности-владельца: 1 — лид, 3 — контакт, 4 — компания, 8 — реквизит. Входит в составной ключ адреса и неизменяем после создания."
      },
      "entityId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "ID владельца",
        "label": "ID владельца",
        "description": "Идентификатор сущности-владельца адреса. Входит в составной ключ адреса и неизменяем после создания."
      },
      "address1": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Улица, дом, корпус, строение",
        "label": "Улица, дом, корпус, строение"
      },
      "address2": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Квартира / офис",
        "label": "Квартира / офис"
      },
      "city": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Город",
        "label": "Город"
      },
      "postalCode": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Почтовый индекс",
        "label": "Почтовый индекс"
      },
      "region": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Район",
        "label": "Район"
      },
      "province": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Область",
        "label": "Область"
      },
      "country": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Страна",
        "label": "Страна"
      },
      "countryCode": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Код страны",
        "label": "Код страны",
        "description": "Двухбуквенный код страны. В документации REST Битрикс24 поле помечено как неиспользуемое и оставленное для обратной совместимости — значение сохраняется как передано, поэтому не стоит рассчитывать, что оно на что-то влияет."
      },
      "locAddrId": {
        "type": "integer",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Идентификатор адреса местоположения",
        "label": "Идентификатор адреса местоположения"
      },
      "anchorTypeId": {
        "type": "integer",
        "isRequired": false,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Тип якорной сущности",
        "label": "Тип якорной сущности",
        "description": "Код типа сущности, к которой привязан адрес: 3 — контакт, 4 — компания. Только для чтения."
      },
      "anchorId": {
        "type": "integer",
        "isRequired": false,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "ID якорной сущности",
        "label": "ID якорной сущности",
        "description": "Идентификатор сущности, к которой привязан адрес. Только для чтения."
      }
    }
  }
}

Пример ответа при ошибке

403 — у API-ключа нет скоупа crm: