#Получить заметку

GET /v1/timeline-logs/:id/note

Возвращает заметку, прикреплённую к одному элементу таймлайна. Если заметки нет — 404 NOTE_NOT_FOUND.

#Параметры

Параметр Тип Обяз. По умолч. Описание
id (path) number да — ID лог-записи (или другого элемента таймлайна)
entityTypeId (query) number да — Тип родительской CRM-сущности
entityId (query) number да — ID родительской записи
itemType (query) number нет 1 1 — запись истории, 2 — дело

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/timeline-logs/5012/note?entityTypeId=2&entityId=100" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/timeline-logs/5012/note?entityTypeId=2&entityId=100" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/timeline-logs/5012/note?entityTypeId=2&entityId=100',
  { headers: { 'X-Api-Key': 'YOUR_API_KEY' } },
)

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

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/timeline-logs/5012/note?entityTypeId=2&entityId=100',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  },
)

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

#Поля ответа

Поле Тип Описание
text string Текст заметки
createdBy number ID пользователя, создавшего заметку. Данные пользователя по ID: GET /v1/users/:id
createdAt datetime Дата создания, ISO 8601 с таймзоной портала
updatedBy number ID пользователя, последним обновившего заметку
updatedAt datetime Дата последнего обновления

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

JSON 
{
  "success": true,
  "data": {
    "text": "Клиент обычно отвечает в течение 2 дней.",
    "createdBy": 1,
    "createdAt": "2026-04-27T10:05:00+03:00",
    "updatedBy": 1,
    "updatedAt": "2026-04-27T10:05:00+03:00"
  }
}

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

404 — у элемента нет заметки:

JSON 
{
  "success": false,
  "error": {
    "code": "NOTE_NOT_FOUND",
    "message": "No note attached to this timeline item"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS Не переданы или некорректны entityTypeId / entityId, либо itemType не равен 1 или 2
404 NOTE_NOT_FOUND Элемент таймлайна существует, но у него нет привязанной заметки
404 ENTITY_NOT_FOUND Элемент таймлайна с таким id не существует
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

#Известные особенности

itemType нужен в каждом запросе, даже на чтение. Заметка идентифицируется не одним itemId, а тройкой родительских координат: entityTypeId + entityId + itemType + itemId. Если itemType опустить, Вайбкод подставит 1 (запись истории таймлайна) — в большинстве случаев это и нужно.

Различение «нет заметки» от «не нашёл элемент». Эндпоинт возвращает 404 NOTE_NOT_FOUND и в случае «у элемента нет заметки», и в случае «элемента с таким id не существует». Чтобы проверить, существует ли сам элемент таймлайна — используйте `GET /v1/timeline-logs/:id`.

#Смотрите также