# List key

URL: https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-key

> Lists the key register.

`GET /v1/patrol/key`

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

|               |                                        |
| ------------- | -------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/patrol/key`   |
| **Method**    | `GET`                                  |
| **Operation** | `get_patrol_key`                       |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY` |

Lists the key register. Neither the officer nor the client reaches it:
patrol.key is its own DocType and its permissions name neither, so there is no
key row for either to read.

## Request

`GET /v1/patrol/key` takes no parameters and no body — the credential is the whole request.

## Response

| Status    | Body                 | Meaning |
| --------- | -------------------- | ------- |
| `200`     | patrol.patrolKeyList | ok      |
| `default` | problem-details      | refused |

`200` body — 6 fields.

| Field           | In   | Type                | Always | Description                                                  |
| --------------- | ---- | ------------------- | ------ | ------------------------------------------------------------ |
| `data`          | body | patrol.patrolKey\[] | —      | Data is every key set held.                                  |
| `data[].holder` | body | string              | —      | Holder is who has it now.                                    |
| `data[].moved`  | body | string              | —      | Moved is when it last changed hands.                         |
| `data[].name`   | body | string              | —      | Name is the key set's reference, which is its document name. |
| `data[].site`   | body | string              | —      | Site is the site the keys open.                              |
| `data[].where`  | body | string              | —      | Where is where the set is kept.                              |

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

## Examples

**CLI**

```bash
hanzo patrol key list
```

**SDK**

**.ts**

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

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

**.py**

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

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

**.go**

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

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

**.rs**

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

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

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

**.java**

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

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

var result = new PatrolApi(client).getPatrolKey();
```

**HTTP**

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

**MCP**

Tool `patrol`, op `get_patrol_key` — 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": "patrol",
         "arguments": {
           "op": "get_patrol_key",
           "input": {}
         }
       }
     }'
```

---

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