List docs

Returns the documents of a space the caller may see, with the teamspaces they are grouped in.

GET /v1/team/docs

Team → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/team/docs`
Method	`GET`
Operation	`get_team_docs`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns the documents of a space the caller may see, with the teamspaces they are grouped in.

These are the Team client's own document rows, so a page created there is here with no sync. Each carries the collaborator id its body opens with on the /v1/team/collaborator socket. A private teamspace's documents are listed only for its members.

Request

3 fields.

Field	In	Type	Required	Description
`space`	query	string	—	Space is the space uuid.
`teamspace`	query	string	—	Teamspace narrows the answer to one teamspace.
`parent`	query	string	—	Parent narrows the answer to one document's children.

Response

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

200 body — 17 fields.

Field	In	Type	Always	Description
`docs`	body	team.teamDoc[]	—	Docs are the documents, grouped by teamspace, then parent, then the order the Team client shows siblings in.
`docs[].author`	body	string	—	Author is the account uuid that created it.
`docs[].collaborator`	body	string	—	Collaborator is the documentId to open the body with on the /v1/team/collaborator Y.js socket: "<space>\|document:class:Document\|<id>\|content".
`docs[].comments`	body	integer (int64)	—	Comments is how many comments it has.
`docs[].createdOn`	body	integer (int64)	—	CreatedOn is when it was created, unix milliseconds.
`docs[].id`	body	string	—	ID is the document's own id.
`docs[].modifiedOn`	body	integer (int64)	—	ModifiedOn is when its title or place last changed, unix milliseconds.
`docs[].parent`	body	string	—	Parent is the document this one is nested under.
`docs[].rank`	body	string	—	Rank orders siblings: compare as plain strings, ascending.
`docs[].space`	body	string	—	Space is the space uuid holding it.
`docs[].teamspace`	body	string	—	Teamspace is the teamspace it belongs to.
`docs[].title`	body	string	—	Title is the document's title.
`teamspaces`	body	team.teamTeamspace[]	—	Teamspaces are the teamspaces the caller may see, by name — the groups a client draws the tree under.
`teamspaces[].archived`	body	boolean	—	Archived reports that the teamspace is closed: its documents still read, and none can be created, moved into it, renamed or commented on.
`teamspaces[].id`	body	string	—	ID is the teamspace document's id, the value teamDoc.teamspace names.
`teamspaces[].name`	body	string	—	Name is what a person sees in a sidebar.
`teamspaces[].private`	body	boolean	—	Private reports that the teamspace is open to its members only.

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.getTeamDocs();

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_docs()

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

resp, _, err := client.TeamAPI.GetTeamDocs(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_docs(&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).getTeamDocs();

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/docs \
  -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

Request

Response

Examples

On this page