Skip to content

List annotations for one event

GET
/timeline/annotations
curl --request GET \
--url 'https://example.com/api/v1/timeline/annotations?source=sync&eventId=1'

Returns every annotation attached to a single timeline event (a thread), oldest first. Orphaned annotations (whose source event no longer exists) remain reachable here by explicit source+eventId but never surface in the merged feed.

source
required

The event source a timeline event originates from.

string
Allowed values: sync canary snapshot rollback
eventId
required
integer

Annotation thread for the event

Media typeapplication/json
Array<object>

A user note attached to a single timeline event.

object
id
required
integer
source
required

The event source a timeline event originates from.

string
Allowed values: sync canary snapshot rollback
eventId
required
integer
body
required
string
authorUserId
required
integer
nullable
authorName
required
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
[
{
"source": "sync"
}
]

Missing or invalid source/eventId

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
"error": "example"
}

Failed to list annotations

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
"error": "example"
}