crm.contact.get
Получить контакт по Id
Описание
Метод crm.contact.get возвращает контакт по его идентификатору.
Чтобы получить список компаний, привязанных к контакту, используйте метод crm.contact.company.items.get.
Параметры
id
integer
обязательный
Идентификатор контакта. Можно получить при помощи методов crm.contact.list или crm.contact.add
Примеры запроса
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
Объект, содержащий в себе информацию о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "ID is not defined or invalid."
}
| Код | Описание | Значение |
|---|---|---|
ID is not defined or invalid |
Параметр id не передан либо переданное значение не является целым числом больше 0 |
|
Access denied |
У пользователя нет прав на «Чтение» контакта | |
Not found |
Контакт с переданным id не найден |

