Получить контакт по Id crm.contact.get
Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.
Scope:
crmКто может выполнять метод: любой пользователь с правом «чтения» контактов
DEPRECATED
Развитие метода остановлено. Используйте crm.item.get.
Метод crm.contact.get возвращает контакт по его идентификатору.
Чтобы получить список компаний, привязанных к контакту, используйте метод crm.contact.company.items.get.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор контакта. Можно получить при помощи методов |
Примеры кода
Как использовать примеры в документации
Получить контакт с id = 23
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":23}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":23,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.contact.get
try
{
const response = await $b24.callMethod(
'crm.contact.get',
{
id: 23,
}
);
const result = response.getData().result;
result.error()
? console.error(result.error())
: console.info(result)
;
}
catch( error )
{
console.error('Error:', error);
}
try {
$contactId = 123; // Example contact ID
$contactResult = $serviceBuilder
->getCRMScope()
->contact()
->get($contactId);
$itemResult = $contactResult->contact();
print("ID: " . $itemResult->ID . PHP_EOL);
print("Name: " . $itemResult->NAME . PHP_EOL);
print("Last Name: " . $itemResult->LAST_NAME . PHP_EOL);
print("Birthday: " . $itemResult->BIRTHDATE?->format(DATE_ATOM) . PHP_EOL);
print("Created Date: " . $itemResult->DATE_CREATE->format(DATE_ATOM) . PHP_EOL);
print("Modified Date: " . $itemResult->DATE_MODIFY->format(DATE_ATOM) . PHP_EOL);
} catch (Throwable $e) {
print("Error: " . $e->getMessage() . PHP_EOL);
}
BX24.callMethod(
'crm.contact.get',
{
id: 23,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.contact.get',
[
'ID' => 23
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"ID": "43",
"POST": "Администратор",
"COMMENTS": "\nПример комментария внутри контакта\n\n[B]Жирный текст[\/B]\n[I]Курсив[\/I]\n[U]Подчеркнутый[\/U]\n[S]Зачеркнутый[\/S]\n[B][I][U][S]Микс[\/S][\/U][\/I][\/B]\n\n[LIST]\n[*]Элемент списка #1\n[*]Элемент списка #2\n[*]Элемент списка #3\n[\/LIST]\n\n[LIST=1]\n[*]Нумерованный элемент списка #1\n[*]Нумерованный элемент списка #2\n[*]Нумерованный элемент списка #3\n[\/LIST]\n",
"HONORIFIC": "HNR_RU_1",
"NAME": "Иван",
"SECOND_NAME": "Иванович",
"LAST_NAME": "Иванов",
"PHOTO": null,
"LEAD_ID": null,
"TYPE_ID": "PARTNER",
"SOURCE_ID": "WEB",
"SOURCE_DESCRIPTION": "*Дополнительно об источнике*",
"COMPANY_ID": "12",
"BIRTHDATE": "2001-11-11T02:00:00+02:00",
"EXPORT": "N",
"HAS_PHONE": "Y",
"HAS_EMAIL": "Y",
"HAS_IMOL": "N",
"DATE_CREATE": "2024-08-15T10:38:21+02:00",
"DATE_MODIFY": "2024-08-15T10:38:21+02:00",
"ASSIGNED_BY_ID": "6",
"CREATED_BY_ID": "1",
"MODIFY_BY_ID": "1",
"OPENED": "Y",
"ORIGINATOR_ID": null,
"ORIGIN_ID": null,
"ORIGIN_VERSION": null,
"FACE_ID": null,
"LAST_ACTIVITY_TIME": "2024-08-15T10:38:21+02:00",
"ADDRESS": null,
"ADDRESS_2": null,
"ADDRESS_CITY": null,
"ADDRESS_POSTAL_CODE": null,
"ADDRESS_REGION": null,
"ADDRESS_PROVINCE": null,
"ADDRESS_COUNTRY": null,
"ADDRESS_LOC_ADDR_ID": null,
"UTM_SOURCE": "yandex",
"UTM_MEDIUM": "CPC",
"UTM_CAMPAIGN": "summer_sale",
"UTM_CONTENT": "header_banner",
"UTM_TERM": "discount",
"PARENT_ID_1224": "12",
"LAST_ACTIVITY_BY": "1",
"UF_CRM_1720697698689": "Пример значения пользовательского поля с типом \u0022Строка\u0022",
"PHONE": [
{
"ID": "156",
"VALUE_TYPE": "WORK",
"VALUE": "+7333333555",
"TYPE_ID": "PHONE"
},
{
"ID": "157",
"VALUE_TYPE": "HOME",
"VALUE": "+35599888666",
"TYPE_ID": "PHONE"
}
],
"EMAIL": [
{
"ID": "158",
"VALUE_TYPE": "MAILING",
"VALUE": "ivanov@example.mailing",
"TYPE_ID": "EMAIL"
},
{
"ID": "159",
"VALUE_TYPE": "WORK",
"VALUE": "ivanov@example.work",
"TYPE_ID": "EMAIL"
}
]
},
"time": {
"start": 1723736139.883652,
"finish": 1723736140.299369,
"duration": 0.41571712493896484,
"processing": 0.14158892631530762,
"date_start": "2024-08-15T17:35:39+02:00",
"date_finish": "2024-08-15T17:35:40+02:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Содержит информацию о полях контакта. Структура описана ниже |
|
time |
Объект, содержащий в себе информацию о времени выполнения запроса |
contact
|
Название |
Описание |
|
ID |
Идентификатор контакта |
|
POST |
Должность |
|
COMMENTS |
Комментарий |
|
HONORIFIC |
Обращение |
|
NAME |
Имя |
|
SECOND_NAME |
Отчество |
|
LAST_NAME |
Фамилия |
|
PHOTO |
Фотография |
|
LEAD_ID |
Идентификатор лида, на основе которого был создан контакт |
|
TYPE_ID |
Тип контакта |
|
SOURCE_ID |
Источник |
|
SOURCE_DESCRIPTION |
Дополнительно об источнике |
|
COMPANY_ID |
Идентификатор основной компании |
|
BIRTHDATE |
Дата рождения |
|
EXPORT |
Участвует ли в экспорте контактов. Возможные значения:
|
|
HAS_PHONE |
Задан ли телефон. Возможные значения:
|
|
HAS_EMAIL |
Задан ли e-mail. Возможные значения:
|
|
HAS_IMOL |
Задана ли открытая линия. Возможные значения:
|
|
DATE_CREATE |
Дата создания |
|
DATE_MODIFY |
Дата изменения |
|
ASSIGNED_BY_ID |
Ответственный |
|
CREATED_BY_ID |
Кем создан |
|
MODIFY_BY_ID |
Кем изменен |
|
OPENED |
Доступно ли для всех. Возможные значения:
|
|
FACE_ID |
Привязка к лицам из модуля |
|
LAST_ACTIVITY_TIME |
Последняя активность |
|
LAST_ACTIVITY_BY |
Кем осуществлена последняя активность в таймлайне |
|
UTM_SOURCE |
Рекламная система (Yandex-Direct, Google-Adwords и другие) |
|
UTM_MEDIUM |
Тип трафика. Возможные значения:
|
|
UTM_CAMPAIGN |
Обозначение рекламной кампании |
|
UTM_CONTENT |
Содержание кампании. Например, для контекстных объявлений |
|
UTM_TERM |
Условие поиска кампании. Например, ключевые слова контекстной рекламы |
|
PHONE |
Телефон |
|
EMAIL |
|
|
WEB |
Сайт |
|
Мессенджер |
|
|
LINK |
Ссылки. Служебное поле |
Поля связи с внешними источниками данных
Если контакт создан внешней системой, то:
- поле
ORIGINATOR_IDхранит строковый идентификатор этой системы - поле
ORIGIN_IDхранит строковый идентификатор контакта в этой внешней системе - поле
ORIGIN_VERSIONхранит версию данных контакта в этой внешней системе
|
Название |
Описание |
|
ORIGINATOR_ID |
Внешний источник |
|
ORIGIN_ID |
Идентификатор элемента во внешнем источнике |
|
ORIGIN_VERSION |
Версия оригинала |
Устаревшие поля
Поля адреса в контакте являются устаревшими и используются только в режиме совместимости. Для работы с адресом используйте реквизиты.
|
Название |
Описание |
|
ADDRESS |
Адрес |
|
ADDRESS_2 |
Вторая строка адреса |
|
ADDRESS_CITY |
Город |
|
ADDRESS_POSTAL_CODE |
Почтовый индекс |
|
ADDRESS_REGION |
Район |
|
ADDRESS_PROVINCE |
Область |
|
ADDRESS_COUNTRY |
Страна |
|
ADDRESS_LOC_ADDR_ID |
Идентификатор адреса местоположения |
Поля типа crm_multifield
Поля типа crm_multifield (PHONE, EMAIL, WEB, IM, LINK) явно отдаются данным методом только в случае, если значения данного поля не равны null.
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "ID is not defined or invalid."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Описание |
Значение |
|
|
Параметр |
|
|
У пользователя нет прав на «Чтение» контакта |
|
|
Контакт с переданным |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Создать новый контакт crm.contact.add
- Изменить контакт crm.contact.update
- Получить список контактов crm.contact.list
- Удалить контакт crm.contact.delete
- Получить поля контакта crm.contact.fields
- Как изменить или удалить номера телефонов и email
- Добавить событие календаря для работы с клиентами
- Как отправить письмо клиенту от имени сотрудника