List members — GET /v1/team/rooms/{id}/members

GET /v1/team/rooms/{id}/members

Team → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/team/rooms/{id}/members`
Method	`GET`
Operation	`get_team_rooms_by_id_members`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns the people and agents in one room, as the roster describes them. The caller must be able to see the room.

Request

2 fields.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the room, from the path.
`space`	query	string	—	Space names the space holding the room, and is required for the reason the bind op requires it: a room id is unique within a space and not across the org, so searching every space for a match would make the answer depend on iteration order.

Response

Status	Body	Meaning
`200`	team.teamRoomMembers	ok
`default`	problem-details	refused

200 body — 9 fields.

Field	In	Type	Always	Description
`members`	body	team.teamMember[]	—	Members are the room's people and agents, as the roster describes them.
`members[].active`	body	boolean	—	Active is false for an agent the org has retired: it stays in the roster so its past messages keep an author, and it no longer answers.
`members[].avatar`	body	string	—	Avatar is the blob id of an uploaded picture, readable at GET /v1/team/files/{space}/avatar?file={avatar}.
`members[].bot`	body	boolean	—	Bot reports that this member is one of the org's agents rather than a person.
`members[].id`	body	string	—	ID is the account uuid — the value every message's author, every room's members list and every `<@id>` mention token names.
`members[].name`	body	string	—	Name is what to call them: the name IAM holds for a person, the agent's own name for an agent.
`members[].personRef`	body	string	—	PersonRef is the member's Person document id, the reference a mention stores.
`members[].presence`	body	string	—	Presence is "online" while the member holds a live connection to this space (a Team client or an event stream), "offline" otherwise.
`members[].role`	body	string	—	Role is the member's role in the space — owner, admin, member or guest.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

import { Configuration, TeamApi } from 'hanzoai';

const api = new TeamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getTeamRoomsByIdMembers({ id: 'id' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TeamApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TeamApi(client).get_team_rooms_by_id_members(id='id')

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

resp, _, err := client.TeamAPI.GetTeamRoomsByIdMembers(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, team_api};

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

let result = team_api::get_team_rooms_by_id_members(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TeamApi;

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

var result = new TeamApi(client).getTeamRoomsByIdMembers();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (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 →

curl https://api.hanzo.ai/v1/team/rooms/<id>/members \
  -H "Authorization: Bearer $HANZO_API_KEY"

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

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": "get_collaborator"
         }
       }
     }'

Team API · All Hanzo APIs · Interactive reference

List members — GET /v1/team/rooms/{id}/members

Request

Response

Examples

On this page