v6

latestOpenAPI 3.1.0raw.githubusercontent.com2025-06-241833312.7 KB
Events

List events

Retrieves a paginated list of events belonging to the authenticated user.

get/v1/events

Query parameters

takenumber
fromstring

Response

Successfully retrieved the list of events.

Example response

{
  "data": [
    {
      "id": "event_euyrvozb9302uwhq",
      "type": "file.created",
      "data": {
        "id": "file_euyrvozb9302uwhq",
        "name": "generated-file",
        "type": "image/png",
        "properties": {
          "width": 1920,
          "height": 1080,
          "size": 1024
        },
        "task_id": "task_euyrvozb9302uwhq"
      },
      "timestamp": "2023-10-01T12:00:00Z"
    }
  ],
  "links": {
    "previous": "https://api.scan-documents.com/events?from=event_euyrvozb9302uwhq&take=1",
    "next": "https://api.scan-documents.com/events?from=event_euyrvozb9302uwhq&take=1"
  }
}