Skip to main content
GET
List workspace activities

Path Parameters

workspaceId
string<uuid>
required

Workspace identifier.

Query Parameters

actor
string<uuid>

Account id whose activities to keep. Omit for any actor.

type
string[]

Keep only these activity types (e.g. document.created). Repeat the type parameter for several; omit for no type constraint.

The type of activity performed in a workspace, for audit logging.

Corresponds to the ACTIVITY_TYPE PostgreSQL enum and categorizes the activities that occur within workspaces for a comprehensive audit trail.

Allowed value: "workspace.created"
from
string<date>

First day of the range (inclusive), YYYY-MM-DD. Defaults so the range spans the last DEFAULT_WINDOW_DAYS days through to.

to
string<date>

Last day of the range (inclusive), YYYY-MM-DD. Defaults to today (UTC).

after
string

Cursor pointing to the last item of the previous page. Obtain this from the nextCursor field in the response.

includeCount
boolean
default:false

Whether to include the total item count in the response's total field. Defaults to false, since counting is an extra query; set it to true only when the count is actually needed.

limit
integer<uint32>

The maximum number of records to return (1-100, default: 20).

Required range: 1 <= x <= 100

Response

Generic paginated response wrapper.

Provides a consistent structure for all paginated API responses with cursor-based pagination support. When next_cursor is present, there are more items to fetch.

Generic paginated response wrapper.

Provides a consistent structure for all paginated API responses with cursor-based pagination support. When next_cursor is present, there are more items to fetch.

items
object[]
required

Items in this page.

nextCursor
string

Cursor to fetch the next page. Present only when more items exist.

total
integer<int64>

Total count of items matching the query (if requested).