# List Envelopes — Docusign

> Search for DocuSign envelopes by date, status, email, text, or folder filters. Use this to find envelope IDs for Get Envelope, List Recipients, List Documents, Send Envelope, Void Envelope, or Create Recipient View. See the documentation

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

## Description

Search for DocuSign envelopes by date, status, email, text, or folder filters. Use this to find envelope IDs for **Get Envelope**, **List Recipients**, **List Documents**, **Send Envelope**, **Void Envelope**, or **Create Recipient View**. [See the documentation](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `account` | `string` | No | Your DocuSign account. Leave blank to automatically use your default account, or provide an Account ID (you can use List Accounts to retrieve available accounts). Options are loaded from the connected account. |
| `fromDate` | `string` | No | Return envelopes changed on or after this ISO 8601 datetime, for example 2026-04-01T00:00:00Z. Defaults to 30 days ago. |
| `toDate` | `string` | No | Return envelopes changed on or before this ISO 8601 datetime, for example 2026-04-30T23:59:59Z. |
| `status` | `string[]` | No | Envelope statuses to include. |
| `email` | `string` | No | Filter by recipient or sender email address. |
| `searchText` | `string` | No | Search text matched against envelope metadata. |
| `folderIds` | `string[]` | No | Filter by one or more folder IDs. Options are loaded from the connected account. |
| `count` | `integer` | No | Number of envelopes to request per page. |
| `startPosition` | `integer` | No | Zero-based result offset for the first page. |
| `order` | `string` | No | Sort order. |
| `orderBy` | `string` | No | Field to sort by. |
| `fetchAll` | `boolean` | No | When enabled, follow pagination until no pages remain or Max Pages is reached. |
| `maxPages` | `integer` | No | Maximum pages to retrieve when Fetch All Pages is enabled. |

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

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: "docusign-list-envelopes",
  arguments: {
    account: "Account",
    fromDate: "From Date",
  },
})
```

**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: "docusign-list-envelopes",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    docusign: { authProvisionId: "apn_xxxxxxx" },
    account: "Account",
    fromDate: "From Date",
  },
})

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": "docusign-list-envelopes",
    "configured_props": {
      "docusign": { "authProvisionId": "apn_xxxxxxx" },
      "account": "Account",
      "fromDate": "From Date"
    }
  }'
```

---

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