Retrieves a list of entity change events for syncing.
Events are lightweight records indicating that entities have changed. Each event contains the entity type, entity ID, and event type (e.g., “asset_created”, “album_deleted”). Clients should fetch full entity data from the appropriate endpoints if needed.
Pagination: Use the after_cursor parameter with the cursor value from the
last event to fetch the next page. The has_more field indicates if more events
exist.
Recommended sync pattern:
sync_endcreated_at_lt=sync_endafter_cursor={last.cursor}&created_at_lt=sync_endhas_more=falsesync_end as checkpoint for next syncHandling deletions: When event_type ends with “_deleted” or “_removed”, the entity
no longer exists. Remove it from your local cache/database. Some deletion events include
a payload field with additional context (e.g., album_asset_removed includes
album_id and asset_id since the junction record is deleted).
Event types:
asset_created, asset_updated, asset_deletedalbum_created, album_updated, album_deletedperson_created, person_updated, person_deletedface_created, face_updated, face_deletedalbum_asset_added, album_asset_removedexif_created, exif_updatedLibrary to list events from. If not provided, uses the user's default library.
Cursor from the last event to paginate from. Pass the cursor field from the last event to get the next page.
Only return events created at or after this timestamp (ISO 8601 format)
Only return events created before this timestamp (ISO 8601 format). Recommended for bounding sync operations.
Comma-separated list of entity types to include (e.g., 'asset,album'). Valid types: asset, album, person, face, album_asset, exif. Default: all types.
Maximum number of events to return (1-500)
1 <= x <= 500