Skip to main content
GET
/
api
/
events
List entity change events
curl --request GET \
  --url https://api.example.com/api/events
{
  "data": [
    {
      "data": {
        "id": "<string>",
        "device_asset_id": "<string>",
        "device_id": "<string>",
        "mime_type": "<string>",
        "original_file_name": "<string>",
        "file_created_at": "2023-11-07T05:31:56Z",
        "file_modified_at": "2023-11-07T05:31:56Z",
        "local_datetime": "2023-11-07T05:31:56Z",
        "checksum": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "checksum_sha1": "<string>",
        "exif": {
          "asset_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "make": "<string>",
          "model": "<string>",
          "orientation": 123,
          "modified_datetime": "2023-11-07T05:31:56Z",
          "original_datetime": "2023-11-07T05:31:56Z",
          "digitized_datetime": "2023-11-07T05:31:56Z",
          "lens_model": "<string>",
          "f_number": 123,
          "focal_length": 123,
          "iso": 123,
          "exposure_time": 123,
          "exposure_bias": 123,
          "latitude": 123,
          "longitude": 123,
          "altitude": 123,
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "description": "<string>",
          "fps": 123,
          "live_photo_cid": "<string>",
          "projection_type": "<string>",
          "profile_description": "<string>",
          "auto_stack_id": "<string>",
          "rating": 123
        },
        "metrics": {},
        "download_url": "<string>",
        "thumbnail_url": "<string>",
        "faces": [
          {
            "id": "<string>",
            "asset_id": "<string>",
            "bounding_box": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "person_id": "<string>",
            "timestamp_ms": 123,
            "thumbnail_url": "<string>"
          }
        ],
        "people": [
          {
            "id": "<string>",
            "is_hidden": true,
            "is_favorite": true,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "birth_date": "2023-12-25",
            "thumbnail_face_id": "<string>",
            "thumbnail_face_url": "<string>"
          }
        ],
        "width": 0,
        "height": 0,
        "file_size_bytes": 0
      },
      "entity_type": "asset"
    }
  ]
}

Query Parameters

​
library_id
string | null

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

​
updated_at_gte
string<date-time> | null

Only return events with updated_at >= this timestamp (ISO 8601 format)

​
updated_at_lt
string<date-time> | null

Only return events with updated_at < 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 events.

​
data
(AssetEventPayload · object | AlbumEventPayload · object | PersonEventPayload · object | FaceEventPayload · object | AlbumAssetEventPayload · object | ExifEventPayload · object)[]
required

List of events, ordered by entity type priority, then updated_at, then entity_id

Event payload for asset entities.