Получить контакт по Id crm.contact.get

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: любой пользователь с правом «чтения» контактов

DEPRECATED

Развитие метода остановлено. Используйте crm.item.get.

Метод crm.contact.get возвращает контакт по его идентификатору.

Чтобы получить список компаний, привязанных к контакту, используйте метод crm.contact.company.items.get.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
id* `integer`	Идентификатор контакта. Можно получить при помощи методов `crm.contact.list` или `crm.contact.add`

Примеры кода

Как использовать примеры в документации

Получить контакт с id = 23

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

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

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type CrmContactResult = {
  ID: string
  NAME: string
  LAST_NAME: string
  TYPE_ID: string
  SOURCE_ID: string
  COMPANY_ID: string
  ASSIGNED_BY_ID: string
  OPENED: string
  BIRTHDATE: ISODate | null
  DATE_CREATE: ISODate | null
  DATE_MODIFY: ISODate | null
  LAST_ACTIVITY_TIME: ISODate | null
}

try {
  const response = await $b24.actions.v2.call.make<CrmContactResult>({
    method: 'crm.contact.get',
    params: {
      id: 23,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Contact:', result.ID, result.NAME, result.LAST_NAME)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getContact() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.contact.get',
        params: {
          id: 23,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Contact:', result.ID, result.NAME, result.LAST_NAME)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getContact)
</script>

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.contact.get", b24.Params{
	"id": 23,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.contact.get: %w", err)
}

var item struct {
	ID         b24.ID `json:"ID"`
	Post       string `json:"POST"`
	Comments   string `json:"COMMENTS"`
	Honorific  string `json:"HONORIFIC"`
	Name       string `json:"NAME"`
	SecondName string `json:"SECOND_NAME"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Post)

Обработка ответа

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 `contact`	Корневой элемент ответа. Содержит информацию о полях контакта. Структура описана ниже
time `time`	Объект, содержащий в себе информацию о времени выполнения запроса

contact

Название `тип`	Описание
ID `integer`	Идентификатор контакта
POST `string`	Должность
COMMENTS `text`	Комментарий
HONORIFIC `crm_status`	Обращение
NAME `string`	Имя
SECOND_NAME `string`	Отчество
LAST_NAME `string`	Фамилия
PHOTO `file`	Фотография
LEAD_ID `crm_lead`	Идентификатор лида, на основе которого был создан контакт
TYPE_ID `crm_status`	Тип контакта
SOURCE_ID `crm_status`	Источник
SOURCE_DESCRIPTION `text`	Дополнительно об источнике
COMPANY_ID `crm_company`	Идентификатор основной компании
BIRTHDATE `date`	Дата рождения
EXPORT `boolean`	Участвует ли в экспорте контактов. Возможные значения: `Y` — да `N` — нет
HAS_PHONE `boolean`	Задан ли телефон. Возможные значения: `Y` — да `N` — нет
HAS_EMAIL `boolean`	Задан ли e-mail. Возможные значения: `Y` — да `N` — нет
HAS_IMOL `boolean`	Задана ли открытая линия. Возможные значения: `Y` — да `N` — нет
DATE_CREATE `datetime`	Дата создания
DATE_MODIFY `datetime`	Дата изменения
ASSIGNED_BY_ID `user`	Ответственный
CREATED_BY_ID `user`	Кем создан
MODIFY_BY_ID `user`	Кем изменен
OPENED `boolean`	Доступно ли для всех. Возможные значения: `Y` — да `N` — нет
FACE_ID `integer`	Привязка к лицам из модуля `faceid`
LAST_ACTIVITY_TIME `datetime`	Последняя активность
LAST_ACTIVITY_BY `user`	Кем осуществлена последняя активность в таймлайне
UTM_SOURCE `string`	Рекламная система (Yandex-Direct, Google-Adwords и другие)
UTM_MEDIUM `string`	Тип трафика. Возможные значения: `CPC` — объявления `CPM` — баннеры
UTM_CAMPAIGN `string`	Обозначение рекламной кампании
UTM_CONTENT `string`	Содержание кампании. Например, для контекстных объявлений
UTM_TERM `string`	Условие поиска кампании. Например, ключевые слова контекстной рекламы
PHONE `crm_multifield[]`	Телефон
EMAIL `crm_multifield[]`	E-mail
WEB `crm_multifield[]`	Сайт
IM `crm_multifield[]`	Мессенджер
LINK `crm_multifield[]`	Ссылки. Служебное поле

Поля связи с внешними источниками данных

Если контакт создан внешней системой, то:

поле ORIGINATOR_ID хранит строковый идентификатор этой системы
поле ORIGIN_ID хранит строковый идентификатор контакта в этой внешней системе
поле ORIGIN_VERSION хранит версию данных контакта в этой внешней системе

Название `тип`	Описание
ORIGINATOR_ID `string`	Внешний источник
ORIGIN_ID `string`	Идентификатор элемента во внешнем источнике
ORIGIN_VERSION `string`	Версия оригинала

Устаревшие поля

Поля адреса в контакте являются устаревшими и используются только в режиме совместимости. Для работы с адресом используйте реквизиты.

Название `тип`	Описание
ADDRESS `string`	Адрес
ADDRESS_2 `string`	Вторая строка адреса
ADDRESS_CITY `string`	Город
ADDRESS_POSTAL_CODE `string`	Почтовый индекс
ADDRESS_REGION `string`	Район
ADDRESS_PROVINCE `string`	Область
ADDRESS_COUNTRY `string`	Страна
ADDRESS_LOC_ADDR_ID `integer`	Идентификатор адреса местоположения

Поля типа crm_multifield

Поля типа crm_multifield (PHONE, EMAIL, WEB, IM, LINK) явно отдаются данным методом только в случае, если значения данного поля не равны null.

Обработка ошибок

HTTP-статус: 400

{
    "error": "",
    "error_description": "ID is not defined or invalid."
}

Название `тип`	Описание
error `string`	Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только `error_description`
error_description `string`	Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Описание	Значение
`ID is not defined or invalid`	Параметр `id` не передан либо переданное значение не является целым числом больше 0
`Access denied`	У пользователя нет прав на «Чтение» контакта
`Not found`	Контакт с переданным `id` не найден

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Изменить контакт

Получить список контактов

Получить контакт по Id crm.contact.get

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

contactcontact

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение