# List docs

URL: https://docs.hanzo.ai/docs/openapi/team/get-team-docs

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

`GET /v1/team/docs`

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

|               |                                        |
| ------------- | -------------------------------------- |
| **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](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

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

**SDK**

**.ts**

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

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

**.py**

```python
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()
```

**.go**

```go
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
}
```

**.rs**

```rust
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?;
```

**.java**

```java
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();
```

**HTTP**

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

**MCP**

MCP reaches **team** through the `team` tool, which names its 33 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_team_account_providers"
         }
       }
     }'
```

---

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