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

Get comment

GET /v1/timelines/:id

Returns a single timeline comment by its ID.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionComment ID. Get the list of IDs — GET /v1/timelines

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/timelines/66303" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/timelines/66303" \
  -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/timelines/66303', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Comment:', data.comment)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/timelines/66303', {
  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 comment. Field descriptions — see Comment fields
Fielddata.id Typenumber DescriptionComment ID
Fielddata.entityType Typestring DescriptionType of the parent CRM record in lowercase: deal, lead, contact, company, dynamic_<entityTypeId>
Fielddata.entityId Typenumber DescriptionParent record ID
Fielddata.comment Typestring DescriptionComment text
Fielddata.authorId Typenumber DescriptionAuthor ID. User data: GET /v1/users/:id
Fielddata.createdAt Typedatetime DescriptionCreation date, ISO 8601 in UTC
Fielddata.FILES Typeobject DescriptionAttached files — only if the comment has any. The key is the Drive file ID and the value holds the file metadata, whose structure is shown on the Add comment page. Download a file through GET /v1/timelines/:commentId/files/:fileRef/download

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 66303,
    "entityId": 575,
    "entityType": "deal",
    "comment": "First contact: the client showed interest in the offer",
    "authorId": 1,
    "createdAt": "2026-04-24T12:34:05.000Z"
  }
}

Error response example

404 — comment not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Not found."
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionA comment with the specified ID does not exist
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

Full list of common API errors — Errors.

See also