Skip to main content
Read an entity activity timeline

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 1000
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 grouping hints for related changes on this page. Pages still count 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.

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