Skip to main content
GET
/
api
/
v2
/
events
List entity change events (v2)
curl --request GET \
  --url https://api.example.com/api/v2/events
{
  "data": [
    {
      "cursor": "<string>",
      "entity_type": "<string>",
      "entity_id": "<string>",
      "event_type": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "payload": {}
    }
  ],
  "has_more": true
}

Query Parameters

library_id
string | null

Library to list events from. If not provided, uses the user's default library.

after_cursor
string | null

Cursor from the last event to paginate from. Pass the cursor field from the last event to get the next page.

created_at_gte
string<date-time> | null

Only return events created at or after this timestamp (ISO 8601 format)

created_at_lt
string<date-time> | null

Only return events created before this timestamp (ISO 8601 format). Recommended for bounding sync operations.

entity_types
string | null

Comma-separated list of entity types to include (e.g., 'asset,album'). Valid types: asset, album, person, face, album_asset, exif. Default: all types.

limit
integer
default:100

Maximum number of events to return (1-500)

Required range: 1 <= x <= 500

Response

Successful Response

Response containing a page of v2 events.

data
EventV2Response · object[]
required

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

has_more
boolean
required

True if there are more events after this page. Use the last event's cursor to fetch the next page.