Skip to main content
GET
Error

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required

Query Parameters

cursor
string

The next_cursor of the previous page. Omit it to read from the beginning, or pass start=now instead to begin at the present. A cursor admits the type filter it was minted under and any narrower one; a wider filter is a 400 — restart from an earlier cursor to widen.

start
enum<string>

start=now answers an empty page whose next_cursor is the present: poll from it to receive only events that happen after this call, without replaying history. Takes no cursor; the minted cursor is unfiltered, so it admits any later type filter.

Available options:
now
limit
number
default:50
Required range: 1 <= x <= 200
type
string

Comma-separated event types to include (branch.changed, branch.rebased, branch.created, branch.ready_for_review, branch.draft, branch.approved, branch.rejected, branch.review_cleared, branch.reviewer_removed, branch.owner_changed, branch.editor_groups_changed, branch.approval_dismissed, branch.admin_bypass, branch.closed, branch.reopened, branch.merged, branch.extracted, branch.extraction_undone). Omit to read every type.

branch
string

Only events of one branch: a branch id, or "master" for Base. Omit to read every branch. Like type, a cursor minted under a branch admits only that branch (a wider poll is a 400).

Response

200 - application/json
events
object[]
required
more_available
boolean
required

True when this page filled the requested limit and more settled events wait beyond it.

next_cursor
string
required

Position from which the next read continues. Pass it back as cursor. It is a checkpoint, not merely the last delivered event: when the page is short it is the stream’s settled floor, so nothing at or below it can appear later.