---
title: "List a case's upgrades"
method: GET
path: "/v1/projects/{project_id}/playbook-cases/{case_id}/upgrades"
tags: ["Playbooks"]
---

# List a case's upgrades

`GET /v1/projects/{project_id}/playbook-cases/{case_id}/upgrades`

## Request

- Base URL: `https://api.naturali.ai`
- URL: `https://api.naturali.ai/v1/projects/{project_id}/playbook-cases/{case_id}/upgrades`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.naturali.ai/authorize`, token URL `https://api.naturali.ai/token`, scopes: `mcp:access`)

Returns every version change of the case, newest first.

## Path parameters

- `case_id` string, required

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

List of upgrades, newest first

- object
  - `data` PlaybookUpgrade[], required
    - `id` string
    - `case_id` string
    - `from_version` integer: The version the case was on
    - `to_version` integer: The version the case moved to
    - `diff` object: What moved between the two versions, by node ID
      - `added` string[]: Nodes the new version adds
      - `removed` string[]: Nodes the new version drops
      - `changed` object[]: Nodes in both whose executor or inputs changed; a title, description or transformation change is not listed
        - `node_id` string
        - `executor` boolean: Whether the node's executor changed
        - `inputs` object[]
          - `name` string
          - `change` 'added' | 'removed' | 'source' | 'schema' | 'required'
    - `created_by_principal_type` 'user' | 'api_key' | 'agent' | 'automation' | 'approval' | 'system': What kind of principal acted. `user` and `api_key` are authenticated callers, and the id is the user's (`user_…`) or the key's own (`key_…`), so a record names which key acted rather than its owner. `agent` is an agent writing under its own identity (`agent_…`). `automation` is the task engine acting on a dispatch outcome and `approval` an approval resolution; neither carries an id. `system` is the platform itself, with an id naming the mechanism (`retention_sweep`, `zero_retention`).
    - `created_by_principal_id` string, nullable: Public id of that principal: the user (`user_…`), or for API key auth the key itself (`key_…`), so the record names which key acted.
    - `on_behalf_of` OnBehalfOf, nullable: The tool call the write was made on behalf of, for a write a `naturali` tool made; null for any other write. Attribution only: the `created_by_principal_*` pair and the permissions checked are the project credential's.
      - `tool_id` string, nullable
      - `agent_id` string, nullable: The agent whose turn called the tool
      - `generation_id` string, nullable: The generation that called the tool
      - `session_id` string, nullable
      - `actor_id` string, nullable
    - `created_at` string, date-time
  - `total` integer, required
  - `limit` integer, required
  - `offset` integer, required

## Other responses

- `401`: Unauthorized
- `404`: Case not found

---

[API](https://skmtc.dev/naturali/apis/naturali-ai-api.md) · [All operations](https://skmtc.dev/naturali/apis/naturali-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/naturali/apis/naturali-ai-api/revisions/e4905b78f422?raw)