Skip to content

Get event log

GET
/v1/projects/{id}/events

The durable, append-only history of every state change a book has gone through — an audit trail you can also use to catch up after a disconnect. Pass the last eventId you saw as afterEventId to resume exactly where you left off instead of re-reading everything.

Authorizations

Bearer

JWT bearer token from POST /v1/auth/login.

Type
HTTP (bearer)
or
ApiKey

Scoped API key for non-interactive clients (issued by PBI #1426).

Type
API Key (header: X-Api-Key)

Parameters

Path Parameters

id*
Type
string
Required
Format
"uuid"

Query Parameters

afterEventId
Type
[ "integer", "string" ]
Format
"int64"
Pattern
"^-?(?:0|[1-9]\\d*)$"
limit
Type
[ "integer", "string" ]
Format
"int32"
Pattern
"^-?(?:0|[1-9]\\d*)$"

Responses

OK

application/json

Response for GET /v1/projects/{id}/events (PBI #2002): a page of the project's append-only
lifecycle events (oldest-first) plus the replay cursor. long? ProjectEventsPage.NextCursor is non-null when a full
page was returned (more may remain — call again with afterEventId=nextCursor); null when caught up.

Format"int64"
Pattern"^-?(?:0|[1-9]\\d*)$"

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI