Получить набор компаний, связанных с указанным контактом crm.contact.company.items.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь с правом «чтения» контактов
Метод crm.contact.company.items.get возвращает набор компаний, связанных с указанным контактом.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор контакта. Идентификатор можно получить с помощью методов crm.contact.list или crm.contact.add |
Примеры кода
Как использовать примеры в документации
Пример получения всех привязанных компаний у контакта с id = 54
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":54}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.company.items.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":54,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.contact.company.items.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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each contact-company binding returned in result[]
type CrmContactCompanyBinding = {
COMPANY_ID: number
SORT: number
ROLE_ID: number
IS_PRIMARY: string
}
try {
const response = await $b24.actions.v2.call.make<CrmContactCompanyBinding[]>({
method: 'crm.contact.company.items.get',
params: {
id: 54,
},
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 companies:', result.length, result)
}
} 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 getContactCompanyItems() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.contact.company.items.get',
params: {
id: 54,
},
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 companies:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getContactCompanyItems)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.contact.company.items.get(
bitrix_id=54,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.contact.company.items.get',
[
'id' => 54,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting contact company items: ' . $e->getMessage();
}
BX24.callMethod(
'crm.contact.company.items.get',
{
id: 54,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.contact.company.items.get',
[
'id' => 54
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.contact.company.items.get", b24.Params{
"id": 54,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.contact.company.items.get: %w", err)
}
var items []struct {
CompanyID b24.ID `json:"COMPANY_ID"`
Sort int `json:"SORT"`
RoleID b24.ID `json:"ROLE_ID"`
IsPrimary string `json:"IS_PRIMARY"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.CompanyID, it.Sort)
}
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"COMPANY_ID": 7,
"SORT": 100,
"ROLE_ID": 0,
"IS_PRIMARY": "Y"
},
{
"COMPANY_ID": 8,
"SORT": 110,
"ROLE_ID": 0,
"IS_PRIMARY": "N"
},
{
"COMPANY_ID": 9,
"SORT": 120,
"ROLE_ID": 0,
"IS_PRIMARY": "N"
}
],
"time": {
"start": 1724078791.470108,
"finish": 1724078791.969407,
"duration": 0.4992990493774414,
"processing": 0.19150400161743164,
"date_start": "2024-08-19T16:46:31+02:00",
"date_finish": "2024-08-19T16:46:31+02:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Содержит массив с информацией о привязанных к контакту компаниях |
|
time |
Информация о времени выполнения запроса |
Параметр contact_company_binding
|
Название |
Описание |
|
COMPANY_ID |
Идентификатор компании |
|
SORT |
Индекс сортировки |
|
ROLE_ID |
Идентификатор роли (зарезервировано) |
|
IS_PRIMARY |
Является ли привязка первичной. Возможные значения:
|
Обработка ошибок
HTTP-статус: 200
{
"error": "",
"error_description": "The parameter ownerEntityID is invalid or not defined."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
Пустое значение |
|
Передан |
|
|
|
У пользователя нет прав на чтение контактов |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить компанию к указанному контакту crm.contact.company.add
- Удалить компанию из указанного контакта crm.contact.company.delete
- Получить поля для связи контакт-компания crm.contact.company.fields
- Установить набор компаний, связанных с указанным контактом crm.contact.company.items.set
- Очистить набор компаний, связанных с указанным контактом crm.contact.company.items.delete