For AI agents: markdown of this page — /docs-content-en/timeline-logs/notes/get.md documentation index — /llms.txt

Get note

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

Returns the note attached to a single timeline item. If there is no note, or no item with this id exists, it returns 404.

Parameters

Parameter Type Required Default Description
Parameterid (path) Typenumber Requiredyes Default— DescriptionID of the log entry (or another timeline item)
ParameterentityTypeId (query) Typenumber Requiredyes Default— DescriptionType of the parent CRM entity
ParameterentityId (query) Typenumber Requiredyes Default— DescriptionID of the parent record
ParameteritemType (query) Typenumber Requiredno Default1 Description1 — history entry, 2 — activity

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.com/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 application

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.com/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()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionThe note of the timeline item
Fielddata.text Typestring DescriptionNote text
Fielddata.createdBy Typenumber DescriptionID of the user who created the note. User data by ID: GET /v1/users/:id
Fielddata.createdAt Typedatetime DescriptionCreation date, ISO 8601 in the Bitrix24 account timezone
Fielddata.updatedBy Typenumber DescriptionID of the user who last updated the note
Fielddata.updatedAt Typedatetime DescriptionLast update date

Response example

JSON 
{
  "success": true,
  "data": {
    "text": "The client usually replies within 2 days.",
    "createdBy": 1,
    "createdAt": "2026-04-27T10:05:00+00:00",
    "updatedBy": 1,
    "updatedAt": "2026-04-27T10:05:00+00:00"
  }
}

Error response example

404 — the item has no note, or the item itself does not exist:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Item not found"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionentityTypeId / entityId are missing or invalid, or itemType is not 1 or 2
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe timeline item has no note, or no item with this id exists. Message: Item not found
HTTP404 CodeNOTE_NOT_FOUND DescriptionBitrix24 answered without an error, but the response carries no note
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

Full list of common API errors — Errors.

Known specifics

A note is identified by four coordinates, not by a single itemId. They are entityTypeId + entityId + itemType + itemId. If itemType is omitted, Vibecode substitutes 1, a timeline history entry. For an activity note, pass itemType=2.

Distinguishing "no note" from "item not found". The endpoint returns 404 ENTITY_NOT_FOUND both when "the item has no note" and when "no item with this id exists". For an item without a note, Bitrix24 returns an error rather than an empty response. To check whether the timeline item itself exists, use GET /v1/timeline-logs/:id.

See also