---
title: "List hook call logs"
method: GET
path: "/api/v1/hooks/logs"
tags: ["Hook Run"]
deprecated: true
---

# List hook call logs

`GET /api/v1/hooks/logs`

> **Deprecated.**

**⚠️ Deprecated**: Use [List hook runs](/api/hook-run#list-hook-runs) instead.

List all the logs from all running hooks with optional filters and pagination.

The logs are sorted by the `start` timestamp in descending order.

## Query parameters

- `request_id` string
- `log_level` string
- `hook` integer
- `timestamp_before` string, date-time
- `timestamp_after` string, date-time
- `start_before` string, date-time
- `start_after` string, date-time
- `status` 'waiting' | 'running' | 'completed' | 'cancelled' | 'failed'
- `status_code` integer
- `queue` integer[]
- `annotation` integer[]
- `email` integer
- `search` string
- `page_size` integer

## Response `200`

OK

- HookLogsResponse
  - `results` object[], required
    - `timestamp` string, date-time — Timestamp of the log entry.
    - `request_id` string — Request ID of the hook call.
    - `event` string — Event that triggered the hook.
    - `action` string — Action that was performed.
    - `annotation_id` integer, nullable — ID of the related annotation. Only present for `annotation_content` and `annotation_status` events.
    - `queue_id` integer, nullable — ID of the related queue.
    - `email_id` integer, nullable — ID of the related email. Only present for `email` events.
    - `hook_id` integer — ID of the hook.
    - `hook_type` string — Type of the hook.
    - `message` string — Log message.
    - `request` string — Request payload.
    - `response` string — Response payload.
    - `output` string, nullable — Output logged by the hook (e.g. console output of a serverless function).
    - `start` string, date-time — Start timestamp.
    - `end` string, date-time — End timestamp.
    - `settings` string — Hook settings.
    - `status` 'waiting' | 'running' | 'completed' | 'cancelled' | 'failed' — Status of the hook call.
    - `uuid` string — UUID of the hook call.
  - `pagination` Pagination, required
    - `next` string, uri, nullable — URL for the next page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the next page — do not attempt to construct or modify the cursor value.
    - `previous` string, uri, nullable — URL for the previous page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the previous page — do not attempt to construct or modify the cursor value.

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

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