View as Markdown
Docusign icon

Docusign ACTION

List Recipients

List recipients and recipient status for a DocuSign envelope. Use Include Tabs when you need each recipient's tab values and placement. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Docusign account once, then configure and run List Recipients from your backend or agent.

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-recipients",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    docusign: { authProvisionId: "apn_xxxxxxx" },
    account: "Account",
    envelopeId: "Envelope ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Recipients inputs
Property Type Description
account Account string
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).
Optional Dynamic
envelopeId Envelope ID string
The DocuSign envelope ID.
Required Dynamic
includeTabs Include Tabs boolean
Whether to include each recipient's tabs.
Optional
includeExtended Include Extended boolean
Whether to include extended recipient information.
Optional
includeMetadata Include Metadata boolean
Whether to include metadata.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
docusign-list-recipients
Version
0.0.2
App
Docusign
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes