---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Read history on a run"
description: "`workflows.runs.read_history` (GET /v1/{name}:readHistory): Reads a page of the Run's immutable history, projected to Sylphx events."
type: reference
product: workflows
summary: "Reads a page of the Run's immutable history, projected to Sylphx events."
updated: 2026-09-28
nav: false
---

Reads a page of the Run's immutable history, projected to Sylphx events.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run:readHistory`
- **Scope** `workflows:read`
- **Effect** `read` — nothing is written.
- **Collection** [runs](/docs/api/runs)
- **Query** `page_size`, `page_token`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the run. Required. |
| `page_size` | `int32` | At most this many; default 100, clamped to 1000. |
| `page_token` | `string` | `next_page_token` of the previous page. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `events` | `RunHistoryEvent[]` | The page, oldest first. |
| `next_page_token` | `string` | The token of the next page; empty on the last page. |

### RunHistoryEvent

| Field | Type | What it is |
| --- | --- | --- |
| `sequence` | `int64` | Monotonic sequence number within the Run. Output only. |
| `event_time` | `timestamp` | When the event happened. Output only. |
| `kind` | `RunHistoryEventKind` | What happened. Output only. One of `run_started`, `invocation`, `step_completed`, `sleep_started`, `signal_received`, `child_started`, `cancel_requested`, `run_closed`. |
| `step` | `string` | The step id, for step events. Output only. |
| `attempt` | `int32` | The attempt number, for invocation events. Output only. |
| `attempt_outcome` | `AttemptOutcome` | The attempt outcome, for invocation events. Output only. One of `invoked`, `protocol_error`, `rejected`, `retryable`, `unreached`, `unknown`, `unsigned`. |
| `details` | `struct` | Event details (step output, signal payload, error). Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`PAGE_TOKEN_MISMATCH`](/docs/api/errors/PAGE_TOKEN_MISMATCH) — A page token was reused with different parameters.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run:readHistory" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.workflows.runs.readHistory({ name: 'orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run' })
```

**Rust**

```rust
let mut req = sylphx::workflows::ReadRunHistoryRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run".to_string();
let response = sx.workflows().runs().read_history(req).await?;
```

**CLI**

```bash
sylphx workflows runs read-history orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run
```

**MCP**

```json
{ "method_id": "workflows.runs.read_history", "args": {"name":"orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run"} }
```