> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentlinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List link events

> Read change events using an opaque cursor.

`list_link_events`

Read change events using an opaque cursor. Apply a full page locally before saving next\_cursor.

<Note>Hosted MCP registration verified. These schemas describe the development contract; confirm supported inputs with tools/list. Generic CLI/HTTP calls require a matching development server. Configure LINKTRAIL\_API\_URL; production does not expose these command routes.</Note>

| Access        | Behavior         |
| ------------- | ---------------- |
| `events:read` | Reads saved data |

Reading saved data does not start a verification job. Mutations can change saved records or access; the effects below apply.

## Example request

Connect through [MCP](/guides/connect-mcp), [CLI](/guides/connect-cli), or [HTTP](/guides/connect-http). Replace example identifiers with records from your workspace.

<CodeGroup>
  ```json MCP theme={null}
  {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "list_link_events",
      "arguments": {}
    }
  }
  ```

  ```bash CLI theme={null}
  linktrail call list_link_events --args '{}'
  ```

  ```bash HTTP theme={null}
  curl "$LINKTRAIL_API_URL/v1/commands/list_link_events" \
    -H "Authorization: Bearer $LINKTRAIL_API_KEY" \
    -H 'Content-Type: application/json' \
    --data '{}'
  ```
</CodeGroup>

## Returned result

Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. MCP returns this data in `structuredContent` and in a text content block; generic HTTP and CLI return the JSON result directly.

```json theme={null}
{
  "workspace_id": "ws_example",
  "events": [],
  "next_cursor": "example_opaque_cursor",
  "has_more": false
}
```

## Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

| Field       | Type    | Presence | Meaning and constraints                                                                                           |
| ----------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `cursor`    | string  | Optional | Opaque continuation returned by this same listing; omit for the first page.                                       |
| `limit`     | integer | Optional | Maximum rows in this page or bounded report; subject to the schema maximum. minimum: 1; maximum: 100; default: 50 |
| `projectId` | string  | Optional | Identifier of the project returned by its create or list operation. minLength: 1; maxLength: 200                  |

### Validation and omitted values

Omit cursor for the first page. Keep continuation cursors opaque and use them only with the same listing and filters.

Omitting projectId reads the accessible workspace scope rather than selecting a different project.

Events are ordered by sequence ascending. Apply the entire returned page before persisting the next cursor. Each event feed has its own cursor history.

Without a cursor, reads start at the beginning of retained source-event history. An expired supplied cursor returns snapshot recovery instructions.

### Defaults when omitted

| Field   | Default |
| ------- | ------- |
| `limit` | `50`    |

## Output fields

Fields inside optional or nullable parents apply only when that parent exists. [Common schema conventions](/reference/schemas) explain evidence states, empty lists and extensions.

| Field                          | Type          | Presence | Meaning and constraints                                               |
| ------------------------------ | ------------- | -------- | --------------------------------------------------------------------- |
| `workspace_id`                 | string        | Optional | Workspace that owns this record.                                      |
| `events`                       | array         | Required | events recorded for this result.                                      |
| `events[].id`                  | string        | Required | Resource identifier returned by the operation.                        |
| `events[].workspace_id`        | string        | Optional | Workspace that owns this record.                                      |
| `events[].project_id`          | string / null | Optional | Project that owns this record.                                        |
| `events[].watch_id`            | string        | Optional | watch id recorded for this result.                                    |
| `events[].target_id`           | string        | Optional | target id recorded for this result.                                   |
| `events[].type`                | string        | Optional | type recorded for this result.                                        |
| `events[].created_at`          | string        | Optional | UTC timestamp when the record was created.                            |
| `events[].cursor`              | string        | Optional | cursor recorded for this result.                                      |
| `events[].data`                | object        | Required | data recorded for this result.                                        |
| `events[].data.before`         | any           | Optional | before recorded for this result.                                      |
| `events[].data.after`          | any           | Optional | after recorded for this result.                                       |
| `events[].data.state`          | string        | Optional | Saved lifecycle or evidence state, as enumerated for this record.     |
| `events[].data.reason`         | string / null | Optional | Recorded explanation; null when no explanation applies.               |
| `events[].data.observation_id` | string        | Optional | observation id recorded for this result.                              |
| `next_cursor`                  | string        | Required | Opaque continuation for the same listing; null means no further page. |
| `has_more`                     | boolean       | Required | True when another page is available.                                  |

[Download input schema](/schemas/list_link_events.input.json) · [Download output schema](/schemas/list_link_events.output.json)

## Errors and retries

The command is annotated idempotent. Reuse an accepted idempotency key when the input provides one; changing the payload under a reused key can conflict.

See [error recovery](/reference/errors) for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

## HTTP resource routes

These existing resource routes share the operation’s domain behavior. Their parameter placement, status and response envelope can differ from generic invocation. See [HTTP route details](/reference/http/routes).

| Method and route | Success | Details                                          |
| ---------------- | ------- | ------------------------------------------------ |
| `GET /v1/events` | 200     | Remaining read arguments go in query parameters. |

## Continue

[export\_link\_watches](/reference/commands/export_link_watches)

Follow the [related workflow](/guides/monitor-changes), inspect [capability status](/capability-status), or return to the [command index](/reference/index).