curl --request GET \
--url http://localhost:3500/v1/activity \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/activity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/activity"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"type": "activity",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_type": "agreement",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"occurred_at": "2023-11-07T05:31:56Z",
"action": "<string>",
"actor": {
"type": "user",
"user_id": "<string>",
"source": "<string>",
"label": "<string>"
},
"detail": {
"schemaVersion": 1,
"changes": [
{
"field": "<string>",
"from": "<string>",
"to": "<string>"
}
],
"data": {},
"operation": "<string>",
"summary": {}
},
"entity_version": 123
}
],
"next_cursor": "<string>",
"groups": [
{
"key": "<string>",
"event_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"first_occurred_at": "2023-11-07T05:31:56Z",
"last_occurred_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Read an entity activity timeline
Returns individual events and top-level comments, newest first. Supports invoices, agreements, individual alerts, claims, and topics (events only). Related-alert inclusion is explicit and adds events only. Alert filters match direct identities and recorded alert references before pagination; they return events only. Cursors retain timestamp precision and bind to the organization, entity and filters. Optional group_changes returns grouping metadata for this page only, using a rolling five-minute window. Comments break groups. value_blind_actions ignores change values for selected actions on the same entity. Pagination always counts entries, including when groups span pages. This is a live feed, not a snapshot or version-history API.
curl --request GET \
--url http://localhost:3500/v1/activity \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/activity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/activity"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"type": "activity",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_type": "agreement",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"occurred_at": "2023-11-07T05:31:56Z",
"action": "<string>",
"actor": {
"type": "user",
"user_id": "<string>",
"source": "<string>",
"label": "<string>"
},
"detail": {
"schemaVersion": 1,
"changes": [
{
"field": "<string>",
"from": "<string>",
"to": "<string>"
}
],
"data": {},
"operation": "<string>",
"summary": {}
},
"entity_version": 123
}
],
"next_cursor": "<string>",
"groups": [
{
"key": "<string>",
"event_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"first_occurred_at": "2023-11-07T05:31:56Z",
"last_occurred_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
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
Maximum number of results per page.
1 <= x <= 100Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.
4096agreement, invoice, alert, claim, topic, invoice_import, document activity, comment true, false Include page-local grouping metadata. Pagination still counts entries, not groups.
true, false Actions grouped by changed field names rather than values. Requires group_changes=true; at most 50 actions.
Override automatic suppression of redundant alert summaries. Omit to suppress only when related alerts contribute events.
true, false is, is_not