# List Documents — PandaDoc

> List documents, optionally filtering by a search query or tags. See the documentation here

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

## Description

List documents, optionally filtering by a search query or tags. [See the documentation here](https://developers.pandadoc.com/reference/list-documents)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `query` | `string` | No | Search query. Filter by document reference number (this token is stored on template level) or name. |
| `tag` | `string` | No | Search tag. Filter by document tag. |
| `status` | `string` | No | Specify the status of documents to return. |
| `id` | `string` | No | Specify document's ID Options are loaded from the connected account. |
| `deleted` | `boolean` | No | Returns only deleted documents. Default is false. |
| `count` | `integer` | No | Specify how many document results to return. Default is 50 documents, maximum is 100 documents. |
| `page` | `integer` | No | Specify which page of the dataset to return. |

## 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": "pandadoc",
      },
    },
  },
)

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: "pandadoc-list-documents",
  arguments: {
    query: "Query",
    tag: "Tag",
  },
})
```

**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: "pandadoc-list-documents",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pandadoc: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    tag: "Tag",
  },
})

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": "pandadoc-list-documents",
    "configured_props": {
      "pandadoc": { "authProvisionId": "apn_xxxxxxx" },
      "query": "Query",
      "tag": "Tag"
    }
  }'
```

---

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