Retrieve a widget annotation

GET

/v1/widgetannotation/{id}/

curl --request GET \
  --url https://example.com/v1/widgetannotation/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \
  --header 'Authorization: Bearer <token>'

Return a single widget annotation by its ID.

Authorizations

• jwtAuth
• basicAuth

Parameters

Path Parameters

id

required

string format: uuid

A UUID string identifying this widget annotation.

Responses

200

Media typeapplication/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object

account

required

string format: uuid

agent

string format: uuid

nullable

description

string

end_time

required

string format: date-time

id

required

string format: uuid

outage

boolean

start_time

required

string format: date-time

title

required

string

<= 100 characters

widget

required

string format: uuid

Example^generated

{
  "agent": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "description": "example",
  "end_time": "2026-04-15T12:00:00Z",
  "outage": true,
  "start_time": "2026-04-15T12:00:00Z",
  "title": "example",
  "widget": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}