Documentation

crm.timeline.note.get

crm.timeline.note.get(
{
   ownerTypeId: number,
   ownerId: number,
   itemType: number,
   itemId: number
}
)

This method gets note details.

Parameters

Parameter Description
ownerTypeId Item type ID (list with available types).
ownerId Item ID
itemType Item type to apply the note:
  1. history entry,
  2. activity
itemId Item ID to apply the note:
In case of itemType=1, its ID for timeline history entry,
In case of itemType=2, its activity ID.

In case the note was found, result will contain:

  • text - note text
  • createdById - note creator ID
  • createdTime - note date and time
  • updatedById - note editor ID
  • updatedTime - date and time for note update

Example

Use case

crm.timeline.note.get?ownerTypeId=1&ownerId=1&itemId=1&itemType=2

Successful result:

{
  "text": "discount offer",
  "createdById": 1,
  "createdTime": "2022-12-31T12:00:00+03:00",
  "updatedById": 2,
  "updatedTime": "2022-12-31T18:00:00+03:00"
}


© «Bitrix24», 2001-2024