
## 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 |
|----------|-----|:-----:|-----------|---------|
| `id` (path) | number | yes | — | ID of the log entry (or another timeline item) |
| `entityTypeId` (query) | number | yes | — | Type of the parent CRM entity |
| `entityId` (query) | number | yes | — | ID of the parent record |
| `itemType` (query) | number | no | `1` | `1` — history entry, `2` — activity |

## Examples

### curl — personal key

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

### curl — OAuth application

```bash
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 |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | object | The note of the timeline item |
| `data.text` | string | Note text |
| `data.createdBy` | number | ID of the user who created the note. User data by ID: `GET /v1/users/:id` |
| `data.createdAt` | datetime | Creation date, ISO 8601 in the Bitrix24 account timezone |
| `data.updatedBy` | number | ID of the user who last updated the note |
| `data.updatedAt` | datetime | Last 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 |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `entityTypeId` / `entityId` are missing or invalid, or `itemType` is not 1 or 2 |
| 404 | `ENTITY_NOT_FOUND` | The timeline item has no note, or no item with this `id` exists. Message: `Item not found` |
| 404 | `NOTE_NOT_FOUND` | Bitrix24 answered without an error, but the response carries no note |
| 403 | `SCOPE_DENIED` | The API key does not have the `crm` scope |
| 401 | `TOKEN_MISSING` | The API key has no configured tokens |

Full list of common API errors — [Errors](/docs/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`](/docs/timeline-logs/logs/get).

## See also

- [Save note](/docs/timeline-logs/notes/save)
- [Delete note](/docs/timeline-logs/notes/delete)
- [Get log entry](/docs/timeline-logs/logs/get)
