List annotations for one event

GET

/timeline/annotations

const url = 'https://example.com/api/v1/timeline/annotations?source=sync&eventId=1';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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.

Parameters

Query Parameters

source

required

The event source a timeline event originates from.

string

Allowed values: sync canary snapshot rollback

eventId

required

integer

Responses

200

Annotation thread for the event

application/json

Array<object>

A user note attached to a single timeline event.

object

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"
  }
]

400

Missing or invalid source/eventId

application/json

object

error

required

Error message

string

code

Stable machine-readable code present on 5xx responses; error is a fixed user-safe message, raw detail is logged server-side only

string

Allowed values: cleanup_failed library_fetch_failed episodes_fetch_failed releases_fetch_failed

Example

{
  "code": "cleanup_failed"
}

500

Failed to list annotations

application/json

object

error

required

Error message

string

code

Stable machine-readable code present on 5xx responses; error is a fixed user-safe message, raw detail is logged server-side only

string

Allowed values: cleanup_failed library_fetch_failed episodes_fetch_failed releases_fetch_failed

Example

{
  "code": "cleanup_failed"
}