# List members

URL: https://docs.hanzo.ai/docs/openapi/bot/get-bot-members

> Returns the caller org's bots as space members — each with the member account uuid and the Person reference the roster addresses it by.

`GET /v1/bot/members`

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

|               |                                        |
| ------------- | -------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/bot/members`  |
| **Method**    | `GET`                                  |
| **Operation** | `get_bot_members`                      |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY` |

Returns the caller org's bots as space members — each with the member
account uuid and the Person reference the roster addresses it by.

A deployment that runs no team subsystem has no spaces and therefore no
roster, which is an empty list rather than an error: ErrNoPeer is the ONE
error that means "this deployment does not run that app", and every other
failure is an outage and says so.

## Request

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

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | bot.BotRoster   | ok      |
| `default` | problem-details | refused |

`200` body — 6 fields.

| Field              | In   | Type             | Always | Description                                                                                                                                                                   |
| ------------------ | ---- | ---------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bots`             | body | bot.BotMember\[] | —      | Bots is one entry per bot, each carrying the member account uuid and the Person reference the space roster addresses it by.                                                   |
| `bots[].active`    | body | boolean          | —      | Active is whether the agent projects as a LIVE space member, derived from its registry status: empty, "active" and "ready" are live, anything else (archived/retired) is not. |
| `bots[].id`        | body | string           | —      | ID is the agent id.                                                                                                                                                           |
| `bots[].name`      | body | string           | —      | Name is the display name.                                                                                                                                                     |
| `bots[].personRef` | body | string           | —      | PersonRef is the projected Person \_id.                                                                                                                                       |
| `bots[].userId`    | body | string           | —      | UserID is the derived member account uuid (personUuid).                                                                                                                       |

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

## Examples

**CLI**

```bash
hanzo bot members get
```

**SDK**

**.ts**

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

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

**.py**

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

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

**.go**

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

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

**.rs**

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

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

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

**.java**

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

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

var result = new BotApi(client).getBotMembers();
```

**HTTP**

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

**MCP**

MCP reaches **bot** through the `bot` tool, which names its 3 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

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

---

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