# List Spaces — Mode

> List the spaces (called Collections in the Mode UI) visible to the authenticated user. See the documentation

- Key: `mode-list-spaces`
- Type: Action (Read-only)
- Version: 0.0.1
- App: Mode (`mode`) — https://pipedream.com/apps/mode.md
- This page (HTML): https://pipedream.com/apps/mode/actions/list-spaces
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/mode/actions/list-spaces/list-spaces.mjs

## Description

List the spaces (called Collections in the Mode UI) visible to the authenticated user. [See the documentation](https://mode.com/developer/api-reference/management/collections/#listCollections)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `filter` | `string` | No | Optional space filter. Example: all to include personal and all accessible spaces. |
| `limit` | `integer` | No | Maximum number of spaces to return per page (maps to per_page). Must be between 1 and 1000. |
| `page` | `integer` | No | Page of results to return. Providing page (or limit) paginates the response and includes a pagination section with details like the current page and total pages. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "mode",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "mode-list-spaces",
  arguments: {
    filter: "Filter",
    limit: 10,
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "mode-list-spaces",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mode: { authProvisionId: "apn_xxxxxxx" },
    filter: "Filter",
    limit: 10,
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "mode-list-spaces",
    "configured_props": {
      "mode": { "authProvisionId": "apn_xxxxxxx" },
      "filter": "Filter",
      "limit": 10
    }
  }'
```

---

- App: https://pipedream.com/apps/mode.md · All apps: https://pipedream.com/apps