# List timeline

URL: https://docs.hanzo.ai/docs/openapi/patent/get-patent-timeline

> Returns every retained version of one entry, in append order.

`GET /v1/patent/timeline`

> [Patent →](https://docs.hanzo.ai/docs/openapi/patent) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                           |
| ------------- | ----------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/patent/timeline` |
| **Method**    | `GET`                                     |
| **Operation** | `get_patent_timeline`                     |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`    |

Returns every retained version of one entry, in append
order. ?id= names it and ?kind= says which log; a retraction is shown as the
withdrawal it is rather than hidden.

## Request

3 fields.

| Field     | In    | Type   | Required | Description                                                      |
| --------- | ----- | ------ | -------- | ---------------------------------------------------------------- |
| `id`      | query | string | —        | ID is the entry's stable id.                                     |
| `kind`    | query | string | —        | Kind is idea, implementation or disclosure — which log to read.  |
| `project` | query | string | —        | Project narrows inside the org; empty is the caller's own scope. |

## Response

| Status    | Body                  | Meaning |
| --------- | --------------------- | ------- |
| `200`     | patent.PatentTimeline | ok      |
| `default` | problem-details       | refused |

`200` body — 13 fields.

| Field                     | In   | Type                          | Always | Description                                                                       |
| ------------------------- | ---- | ----------------------------- | ------ | --------------------------------------------------------------------------------- |
| `found`                   | body | boolean                       | —      | Found is false when no version of that id exists in this org.                     |
| `id`                      | body | string                        | —      | ID is the entry named.                                                            |
| `kind`                    | body | string                        | —      | Kind is which log was read.                                                       |
| `project`                 | body | string                        | —      | Project is the scope it is filed under.                                           |
| `retained`                | body | integer (int64)               | —      | Retained is len(versions).                                                        |
| `versions`                | body | patent.PatentTimelineEntry\[] | —      | Versions are every retained version, oldest append first.                         |
| `versions[].authored_by`  | body | string                        | —      | AuthoredBy is the validated subject who appended it.                              |
| `versions[].canonical`    | body | boolean                       | —      | Canonical marks the version a listing would return: the latest non-retracted one. |
| `versions[].content_hash` | body | string                        | —      | ContentHash is this version's identity.                                           |
| `versions[].recorded_at`  | body | string                        | —      | RecordedAt is the server clock at the append.                                     |
| `versions[].revision`     | body | string                        | —      | Revision is original, corrected or retracted.                                     |
| `versions[].seq`          | body | integer (int64)               | —      | Seq is the append clock value this version was stamped with.                      |
| `versions[].superseded`   | body | boolean                       | —      | Superseded marks a retained version that a later one replaced.                    |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo patent timeline
```

**SDK**

**.ts**

```ts
import { Configuration, PatentApi } from 'hanzoai';

const api = new PatentApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPatentTimeline();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PatentApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PatentApi(client).get_patent_timeline()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.PatentAPI.GetPatentTimeline(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, patent_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = patent_api::get_patent_timeline(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PatentApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new PatentApi(client).getPatentTimeline();
```

The method above is the one at the current release of the document. `hanzoai@8.5.914` (npm) and `hanzoai@8.5.914` (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. [SDKs →](https://docs.hanzo.ai/docs/sdks)

**HTTP**

```bash
curl https://api.hanzo.ai/v1/patent/timeline \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `patent`, op `get_patent_timeline` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "patent",
         "arguments": {
           "op": "get_patent_timeline",
           "input": {}
         }
       }
     }'
```

---

[Patent API](https://docs.hanzo.ai/docs/openapi/patent) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
