List workspaces

Returns your organization's workspaces, newest first — the scope a team works in, alongside projects rather than instead of them.

GET /v1/iam/workspaces

IAM → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/iam/workspaces`
Method	`GET`
Operation	`get_iam_workspaces`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns your organization's workspaces, newest first — the scope a team works in, alongside projects rather than instead of them.

You see your own organization's workspaces and no one else's; which organization that is comes from your credentials, not from the request.

Request

1 field.

Field	In	Type	Required	Description
`owner`	query	string	—

Response

Status	Body	Meaning
`200`	iam.workspaces.ListOutput	ok
`202`	Approval	held for approval
`default`	problem-details	refused

200 body — 16 fields.

Field	In	Type	Always
`total`	body	integer (int64)	—
`workspaces`	body	iam.Workspace[]	—
`workspaces[].bucket`	body	string	—
`workspaces[].createdAt`	body	string (date-time)	—
`workspaces[].createdTime`	body	string	—
`workspaces[].deleted`	body	boolean	—
`workspaces[].description`	body	string	—
`workspaces[].displayName`	body	string	—
`workspaces[].id`	body	string	—
`workspaces[].isDefault`	body	boolean	—
`workspaces[].metadata`	body	string	—
`workspaces[].name`	body	string	—
`workspaces[].organization`	body	string	—
`workspaces[].owner`	body	string	—
`workspaces[].tags`	body	string[]	—
`workspaces[].updatedAt`	body	string (date-time)	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo iam workspaces list

.ts

.py

.go

.rs

.java

import { Configuration, IamApi } from 'hanzoai';

const api = new IamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getIamWorkspaces();

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = IamApi(client).get_iam_workspaces()

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

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

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

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

let result = iam_api::get_iam_workspaces(&cfg, Default::default()).await?;

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

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

var result = new IamApi(client).getIamWorkspaces();

curl https://api.hanzo.ai/v1/iam/workspaces \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches iam through the iam tool, which names its 44 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": "list_iam_applications"
         }
       }
     }'

IAM API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousGet workspaces NextGet organizations