---
title: "List events"
method: GET
path: "/v1/events"
tags: ["Events"]
---

# List events

`GET /v1/events`

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

## Query parameters

- `take` number
- `from` string

## Response `200`

Successfully retrieved the list of events.

- object
  - `data` Event[], required — The list of events
    - union — An event that occurred in the system
      - union — Event emitted when a file is created or deleted
        - FileCreatedEvent — Event emitted when a file is created
          - `id` string, required — The id of the event
          - `timestamp` string, required — The timestamp of the moment when the event was created in ISO 8601 format
          - `type` 'file.created', required — The type of the event
          - `data` union, required — The data of the event
            - object
              - …
            - object
              - …
        - FileDeletedEvent — Event emitted when a file is deleted
          - `id` string, required — The id of the event
          - `timestamp` string, required — The timestamp of the moment when the event was created in ISO 8601 format
          - `type` 'file.deleted', required — The type of the event
          - `data` object, required — The data of the event
            - `id` string, required — The ID of the file
            - `name` string, required — The name of the file
            - `type` 'image/png' | 'image/jpeg' | 'image/webp' | 'application/pdf', required — The type of the file that was deleted
      - union — Event emitted when a task transition occurs
        - TaskCreatedEvent — Event emitted when a task is created
          - `id` string, required — The id of the event
          - `timestamp` string, required — The timestamp of the moment when the event was created in ISO 8601 format
          - `type` 'task.created', required — The type of the event
          - `data` object, required — The data of the event
            - `id` string, required — The ID of the task
            - `operation` 'warp' | 'extract-text' | 'convert' | 'render' | 'split' | 'merge' | 'extract-pages' | 'detect-documents' | 'apply-effect' | 'scan', required — The operation of the task
        - TaskCompletedEvent — Event emitted when a task is completed
          - `id` string, required — The id of the event
          - `timestamp` string, required — The timestamp of the moment when the event was created in ISO 8601 format
          - `type` 'task.completed', required — The type of the event
          - `data` union, required — The data of the event
            - object — Task Event Data
              - …
            - object — Task Event Data
              - …
            - object — Task Event Data
              - …
            - object — Task Event Data
              - …
            - object — Task Event Data
              - …
            - object — Task Event Data
              - …
            - object — Task Event Data
              - …
            - object — Task Event Data
              - …
            - object — Task Event Data
              - …
        - TaskDeletedEvent — Event emitted when a task is deleted
          - `id` string, required — The id of the event
          - `timestamp` string, required — The timestamp of the moment when the event was created in ISO 8601 format
          - `type` 'task.deleted', required — The type of the event
          - `data` object, required — The data of the event
            - `id` string, required — The ID of the task
            - `operation` 'warp' | 'extract-text' | 'convert' | 'render' | 'split' | 'merge' | 'extract-pages' | 'detect-documents' | 'apply-effect' | 'scan', required — The operation of the task
        - TaskFailedEvent — Event emitted when a task fails
          - `id` string, required — The id of the event
          - `timestamp` string, required — The timestamp of the moment when the event was created in ISO 8601 format
          - `type` 'task.failed', required — The type of the event
          - `data` object, required — The data of the event
            - `id` string, required — The ID of the task
            - `operation` 'warp' | 'extract-text' | 'convert' | 'render' | 'split' | 'merge' | 'extract-pages' | 'detect-documents' | 'apply-effect' | 'scan', required — The operation of the task
            - `result` object, required
              - …
  - `links` object, required
    - `previous` string, nullable, required — The URL to the previous page of results
    - `next` string, nullable, required — The URL to the next page of results

## Other responses

- `422` — Validation Error. Invalid query parameters.
- `429` — Rate Limit Exceeded.
- `5XX` — Internal Server Error.

## Changes

- **2025-06-24** `42f9aa9c3b27` — 3 warning, 1 info
  - added the new `scan` enum value to the `data/items/oneOf[subschema #2: Task Event]/oneOf[subschema #1: Task Created Event]/data/operation` response property for the response status `200`
  - added the new `scan` enum value to the `data/items/oneOf[subschema #2: Task Event]/oneOf[subschema #3: Task Deleted Event]/data/operation` response property for the response status `200`
  - added the new `scan` enum value to the `data/items/oneOf[subschema #2: Task Event]/oneOf[subschema #4: Task Failed Event]/data/operation` response property for the response status `200`
  - added the required property `data/items/oneOf[subschema #2: Task Event]/oneOf[subschema #2: Task Completed Event]/data/oneOf[subschema #2: Detect Document Completed Data]/result/documents/items/file_id` to the response with the `200` status

[Change history](https://skmtc.dev/scan-documents/apis/scan-documents-api/changes/v1/events/get.md)

---

[API](https://skmtc.dev/scan-documents/apis/scan-documents-api.md) · [All operations](https://skmtc.dev/scan-documents/apis/scan-documents-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/scan-documents/scan-documents-api/revisions/42f9aa9c3b27/schema)