Skip to main content
GET
Retrieve workspace events
Returns the events on a workspace’s Activity → Feed tab as a feed you can sync, oldest change first. Event types use the same names as webhook events. See Syncing events for how to page through it and keep a copy up to date.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

properties
enum<string>[]

Select the event properties to return. Only id and object are returned by default.

Available options:
type,
occurredAt,
updatedAt,
actorType,
timeSpentSeconds,
parentEventId,
workspace.name,
workspace.workspaceUrl,
workspace.createdAt,
workspace.updatedAt,
actor.createdAt,
actor.updatedAt,
actor.firstName,
actor.lastName,
actor.avatar,
actor.email,
actor.name,
workspacePage.name,
workspacePage.navigationName,
asset.name,
asset.assetType,
asset.assetUrl,
asset.thumbnailUrl,
asset.createdAt,
asset.updatedAt
filters
object

Filter the events. Send the same filters with every page of a sync: a cursor only works with the filters it was issued for.

cursor
string

The nextCursor from the previous response. Leave it out on the first request.

limit
integer

Maximum number of events to scan for this page (1–500, default 100)

Required range: x <= 500

Response

A page of workspace events

data
object