Skip to main content
Read an entity activity timeline

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Query Parameters

limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 100
cursor
string

Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.

Maximum string length: 4096
entity_type
enum<string>
required
Available options:
agreement,
invoice,
alert,
claim,
topic,
invoice_import,
document
entity_id
string<uuid>
required
entry_type
enum<string>
Available options:
activity,
comment
Available options:
true,
false
group_changes
enum<string>
default:false

Include page-local grouping metadata. Pagination still counts entries, not groups.

Available options:
true,
false
value_blind_actions
string

Actions grouped by changed field names rather than values. Requires group_changes=true; at most 50 actions.

suppress_alert_scope_rollups
enum<string>

Override automatic suppression of redundant alert summaries. Omit to suppress only when related alerts contribute events.

Available options:
true,
false
alert_id
string<uuid>
alert_operator
enum<string>
default:is
Available options:
is,
is_not

Response

A page of timeline entries and an opaque next cursor.

data
object[]
required
Maximum array length: 100
next_cursor
string | null
required
groups
object[]
Maximum array length: 100