Skip to main content
GET
Stream entity change events

Query Parameters

library_id
string | null

Library to stream events from. Optional if the user has a single library; required when they have multiple.

after_cursor
string | null

Opaque cursor from the last event of the previous page. Pass the cursor field from the last event to fetch the next page. Omit for the first page.

created_at_gte
string<date-time> | null

Only return events created at or after this timestamp (ISO 8601). Set this to the previous sync's checkpoint when doing incremental sync.

created_at_lt
string<date-time> | null

Only return events created strictly before this timestamp (ISO 8601). Recommended for bounding a sync operation — capture now once and reuse it as created_at_lt across all pages so newly arriving events don't shift the window.

entity_types
string[] | null

Entity types to include (e.g., asset, album). Valid values: asset, album, person, face, album_asset, metadata. Accepts multiple entity_types= query params or a single comma-delimited value (e.g., entity_types=asset,album). Omit to receive events for all types.

limit
integer
default:20

Maximum number of events to return per page (1–200). Defaults to 20.

Required range: 1 <= x <= 200

Response

Successful Response

Response containing a page of events.

data
EventResponse · object[]
required

List of events, ordered by event ID (monotonically increasing)

has_more
boolean
required

True if there are more events after this page. Pass the last event's cursor value as after_cursor to fetch the next page.